什么应该在ASP.NET MVC应用程序中评论？

Question

这里是我感兴趣的点的列表。

我们应该对控制器的操作方法发表评论吗？

原因是为什么我问这是因为操作方法非常自我解释，我能想到的最好的评论就像“返回产品视图”。似乎会导致混乱，并没有多大的帮助。

我们应该在视图中有任何意见吗？

时，Visual Studio生成的操作方法是在这样的评论会自动将...

// 
    // GET: /Products/ 

... 是^好的做法呢？

关于评论/记录ASP.NET MVC应用程序的任何建议/建议？

我没有谷歌的信息，但没有找到任何有用的，这就是为什么我问这里。

Answer 1

我通常会摆脱那些自动生成的评论。我说你应该遵循MVC代码，您遵循常规代码相同的原则：

• 如果一个方法的目的和功能是从它的名字很明显，不要打扰它发表评论。
• 如果很明显代码行正在做什么，为什么，不要麻烦评论它。
• 如果有可能该方法的预期不明显，或者可能有不明显的次要后果，请对其进行评论。
• 如果不是很明显什么一行代码正在做什么，请将代码更改为更清晰。
• 如果不是很明显为什么你正在做你在做什么，请添加评论。

Answer 2

我的做法是不要评论一些东西，除非它绝对需要评论。你的代码应该很容易阅读，评论是不必要的。如果你发现自己需要写评论，那么这可能意味着你可以简化你正在做的事情。