C# 你认为什么是最好的C注释结构？特别是VisualStudio

这些年来，在我完成学业并在这个行业工作的过程中，我经常征求人们对评论的意见。不幸的是，正如我们所知，与许多开发人员进行评论只是一种旁注，而不是其他什么。话虽如此，我通常会得到一个相当笼统的答案。真的，随着时间的推移，这并不能帮助我们看到什么真正有帮助

那么，你认为用VisualStudio构建C的最好方法是什么呢？评论的内容很多而且经常 -比尔博，霍比特人

更严肃地说，评论那些不明显的东西，告诉读者代码的目标是什么，也许还有你为什么选择它

---

这不会因为语言的不同而改变。

至少，我会用一个。这将使自动生成文档变得容易，如果时间到了

---

除此之外，我会评论任何特定的算法或代码片段，这些算法或代码在六个月内将难以破译。这种“自私”的评论方法，即假设您以后必须维护这段代码，通常会在不过度使用的情况下实现大量文档的最佳平衡。

在撰写评论时，我尝试遵循一些基本准则

评论应该很简单 评论应提供明确性 在编写实现之前先编写文档 记录你为什么要做某事，而不是你在做什么。 对接口、方法、属性和类使用内置XML样式的注释。 在每个文件的顶部提供摘要，例如，Something.cs，其中包含文件名、描述、开发历史和版权信息 添加带有错误编号的错误修复注释（如果适用） 利用有用的注释，如//TODO//BUG和//BUGFIX 除非您打算使用，否则不要注释掉代码 在应用注释的代码行上方添加注释，而不是在代码行的末尾 尝试将注释限制为一行 对于多行注释，请使用//，而不是//** 注意不要使用foo、bar等。 在适当的情况下遵循套管规则，即套管和套管

---

就我个人而言，对于更复杂的部分，我使用了三斜杠、SandCastle XML注释和内联注释的组合。经常发表评论，但要保持简洁，没有人需要阅读大量的废话，然后才能弄清楚什么是有用的：-