-1

多年来，当我完成学业并在该行业工作时，我经常向人们征求有关评论的建议。可悲的是，众所周知，与许多开发人员发表评论只是一种旁注，而不是其他东西。话虽如此，我通常会得到一个相当笼统的答案。确实，随着时间的推移，这对了解真正有帮助的东西并没有多大帮助。

那么，您认为使用 Visual Studio 构建 C# 的最佳方式是什么？

4

4 回答 4

9

至少，我会使用三斜杠 XML 注释块来注释您的公共 API 的所有部分。如果时机成熟，这将使自动生成文档变得容易。

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

于 2008-10-09T17:29:47.050 回答
3

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

  • 注释应该很简单
  • 评论应提供清晰
  • 在编写实现之前编写文档
  • 记录你为什么做某事，而不是你在做什么。
  • 对接口、方法、属性和类使用内置（XML 样式）注释。
  • 在每个文件（例如，Something.cs）的顶部提供一个摘要，包括文件名、描述、开发历史和版权信息
  • 为错误修复添加注释（如果合适，带有错误编号）
  • 使用有用的注释，例如 //TODO //BUG 和 //BUGFIX
  • 不要注释掉代码，除非你打算使用它
  • 在它们适用的代码行上方添加注释，而不是在行尾
  • 尝试将评论限制在一行
  • 使用 // 而不是 /* */ 用于多行注释
  • 要清楚——不要使用“foo”、“bar”等。
  • 在适当的情况下遵循大小写规则（即，camelCasing 和 PascalCasing）
于 2008-10-09T17:50:15.060 回答
1

“很多而且经常”——比尔博，霍比特人。

更严重的是，评论不明显的东西，并告诉读者代码的目标是什么，也许你选择它的原因。

这不会因语言而改变。

于 2008-10-09T17:20:17.210 回答
0

对于更复杂的部分，我个人使用三斜杠、SandCastle XML 注释和内联注释的组合。经常评论，但要保持简洁，没有人需要阅读大量的绒毛，然后才能弄清楚某些东西的作用:-)

于 2008-10-09T18:17:39.920 回答