我想知道人们在代码中是否有标准的注释格式。不是方法或类的 xml 注释，而是注释within一个方法。
也可以看看：
是否有注释 C# 代码的标准（如 phpdoc 或 python 的 docstring）？ https://stackoverflow.com/questions/34516/is-there-a-standard-like-phpdoc-or-pythons-docstring-for-commenting-c-code
除了格式之外，您确实应该考虑一些事情来做出好的评论。
- 不要简单地重述代码正在做什么。例如，
// Start the services
StartServices();
这是一个可怕的评论！
描述why。为什么代码会执行它正在执行的操作？业务假设或算法步骤是什么？
格式化您的评论以实现最大程度的可读性。正确地标记它们，在必要时留出空格等。
如果有人已经开始以标准方式发表评论，请不要违反该标准。
查看 MSDN 上这篇有关撰写有效评论的文章：http://msdn.microsoft.com/en-us/library/aa164797.aspx http://msdn.microsoft.com/en-us/library/aa164797.aspx
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
