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

Question

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

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

原因在于我之所以要问这是因为动作方法非常自我解释，我能想到的最佳评论就是“返回产品视图”。似乎造成混乱，并没有多大帮助。

我们的观点中是否有任何评论？

当visual studio生成动作方法时，它会自动输入评论，如...

    //
    // GET: /Products/

     

... 是^良好的做法？

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

我确实谷歌提供了相关信息，但没有找到任何有用的信息，这就是我在这里问的原因。

Answer 1

我的做法是永远不要发表评论，除非绝对需要评论。您的代码应该易于阅读，评论是不必要的。如果您发现自己需要撰写评论，那么这表明您可以简化您正在做的事情。

Answer 2

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

• 如果方法的目的和功能从名称中显而易见，请不要费心评论。
• 如果显而易见的是一行代码正在做什么以及为什么，请不要费心评论它。
• 如果该方法可能具有不明显的预期，或者可能具有不太明显的次要后果，请对其进行评论。
• 如果代码行并不明显，请更改代码以使其更清晰。
• 如果为什么你正在做你正在做的事情并不明显，请添加评论。