什麼應該在ASP.NET MVC應用程序中評論？

Question

這裏是我感興趣的點的列表。

我們應該對控制器的操作方法發表評論嗎？

原因是爲什麼我問這是因爲操作方法非常自我解釋，我能想到的最好的評論就像「返回產品視圖」。似乎會導致混亂，並沒有多大的幫助。

我們應該在視圖中有任何意見嗎？

時，Visual Studio生成的操作方法是在這樣的評論會自動將...

// 
    // GET: /Products/ 

... 是^好的做法呢？

關於評論/記錄ASP.NET MVC應用程序的任何建議/建議？

我沒有谷歌的信息，但沒有找到任何有用的，這就是爲什麼我問這裏。

Answer 1

我通常會擺脫那些自動生成的評論。我說你應該遵循MVC代碼，您遵循常規代碼相同的原則：

• 如果一個方法的目的和功能是從它的名字很明顯，不要打擾它發表評論。
• 如果很明顯代碼行正在做什麼，爲什麼，不要麻煩評論它。
• 如果有可能該方法的預期不明顯，或者可能有不明顯的次要後果，請對其進行評論。
• 如果不是很明顯什麼一行代碼正在做什麼，請將代碼更改爲更清晰。
• 如果不是很明顯爲什麼你正在做你在做什麼，請添加評論。

Answer 2

我的做法是不要評論一些東西，除非它絕對需要評論。你的代碼應該很容易閱讀，評論是不必要的。如果你發現自己需要寫評論，那麼這可能意味着你可以簡化你正在做的事情。