ASP .Net项目中的代码注释

Question

我习惯于在我通常是唯一贡献者的小型项目上工作，但现在我正在开发一个ASP .Net C＃项目，其他人将使用我的代码稍后的。

我相信我会用专业的方式评论我的C＃代码，但是我从来没有在我的ASPX页面中写过评论，除了JavaScript代码。

ASP.Net开发人员可以使用任何“标准”吗？

我是否会在代码隐藏中为了简化阅读页面中生成的操作提供有关注释的信息，或者是过度杀伤？

感谢， 斯特凡

Answer 1

争取自记录代码（需要更少的评论）。

遵循共同的模式（内部或行业）

解释不明显代码“高层意图的”

使用（谨慎）的意见。

Answer 2

了解什么是（可能）需要解释如果由其他人查看。使用GhostDoc插件可以快速写出评论，但请记住验证由插件编写的评论。评论应该是自我解释。