Asp.net mvc 在ASP.NET MVC应用程序中应该注释什么？

以下是我感兴趣的要点列表

我们是否应该对控制员的行动方法发表评论？

我之所以问这个问题，是因为动作方法是非常不言自明的，我能想到的最好的评论应该是“返回产品的视图”。这似乎会造成混乱，并且感觉没有多大帮助

我们应该在视图中有任何评论吗？

当VisualStudio生成动作方法时，它会自动添加注释，如

这是好的做法吗？

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

---

我在谷歌上搜索了有关这方面的信息，但没有发现任何有用的东西，这就是我在这里提问的原因。

我的做法是，除非绝对需要评论，否则永远不要评论任何东西。你的代码应该很容易阅读，注释是不必要的。如果你发现自己需要写评论，这是一个信号，也许你可以简化你正在做的事情

我通常会删除那些自动生成的评论。我认为MVC代码应该遵循与常规代码相同的原则：

• 如果一个方法的目的和功能从它的名称上看是显而易见的，那么不要费心去评论它
• 如果很明显一行代码在做什么以及为什么要这样做，不要费心去评论它
• 如果该方法可能会产生不明显的预期，或者可能产生不明显的次要后果，请对此进行评论
• 如果不清楚一行代码在做什么，请将代码更改为更清晰
• 如果不清楚你为什么要这么做，请添加评论

---

有时您编写代码以解决某些第三方（甚至MVC）限制，在这些情况下，注释是有用的）

    //
    // GET: /Products/