與C＃一起使用GhostDocs有什麼特別的好處？

GhostDocs的重點顯然是記錄你的代碼。它會要求你很好地說明你的方法。然而，使用明確的方法，理論上它們不應該足夠有用以被視爲文檔？與C＃一起使用GhostDocs有什麼特別的好處？

我只想聽聽當前用戶的一些優點/缺點，因爲我不想下載它，並用不必要和重複的文檔混淆了我的代碼。

2012-08-14 SamuelDavis

我以前用過很多GhostDoc，但是發現現在我越來越少用它了。我的方法名稱很好，描述性強，方法通常很小（5-10行）。所以當你在使用這些類時，每個方法所做的都很容易理解。但是當你在其他類中使用xml文檔時非常方便 - 就像你使用類似Sandcastle的東西來構建MSDN樣式文檔以使用代碼一樣。 – 2012-08-14 22:08:28

儘管自我記錄代碼有所幫助，但如果這是您所需要的，那麼任何人都不會諮詢MSDN（順便說一下，.NET庫自身的XML文檔的擴展語言合併HTML形式）。

XML-doc註釋允許您更加詳細地描述類，方法，參數和其他成員，而不是使用標識符。您可以推薦最佳實踐，避免不正確或「黑客」使用您的代碼，詳細說明可能出錯的原因以及原因等等。當您的源代碼不是（如果您正確編譯它的話）時，可以使用此信息，以及當你的代碼不像你想像的那樣自我記錄時（你可能認爲很明顯的許多事情是因爲你以某種方式思考，而不是每個人都會以同樣的方式思考），它是非常寶貴的。

來源

2012-08-14 22:08:50 KeithS

與C＃一起使用GhostDocs有什麼特別的好處？

回答

相關問題