解决XML文档评论困境

Question

关于C＃-code中的XML文档注释，有两种思路：

1. 罗伯特C.马丁的清洁代码方法＆＃34;如果你仔细命名你的 用于表达工作意图的类，方法和变量，
   你不需要评论。＆＃34;
2. 您需要评论每个公共类，接口，方法和属性

由于程序员很懒惰，许多程序员使用GhostDoc或Resharper等工具自动生成XML文档注释。这些工具的目的是提供基本注释，程序员可以轻松扩展。然而，现实表明许多生成的评论保持不变。因此，它们在清晰度或可维护性方面没有为代码增加任何价值。生成的XML文档注释不变只是噪音。在某种程度上，它们是DRY原则违规的一种形式。

在我的团队中，我们意识到这些＆＃34;噪音评论＆＃34;无用。但是，我们并不想全力以赴，而且根本没有评论。方式。 提出的想法是为所有公共成员生成这样的存根：

/// <summary>
/// TODO
/// </summary>

构建（我们使用TFS2013）应该中断，如果有人检查代码并且未触及TODO注释。

我的问题是：

• 有人做过这样的事吗？怎么样？
• 还有其他方法可以解决XML doc困境吗？
• 我担心的是，它会减慢需要处理现有无证代码的团队成员的速度，他们需要做一些代码考古才能检查甚至是小的变化。有关预防的任何想法吗？

Answer 1

虽然不理想，但已有内置规定：

• 请勿使用评论生成器
• 不要使用您建议的存根
• 使用Warning-Level = 4
进行编译
• 检查[x] Xml文档文件
• 检查[x]将警告视为错误