解决XML文档注释困境

Question

关于在C＃中XML文档注释-code有两个思想流派：

1. 罗伯特C.马丁的清洁守则“如果你仔细命名
   类，方法途径和变量来表达你的工作意图，
   你不需要评论。“
2. 你需要每一个注释公共类，接口，方法和属性

由于程序员的懒惰，很多使用工具，如GhostDoc或ReSharper的自动生成XML文档注释。这些工具的意图是提供一个基本的评论，这可以让程序员很容易地扩展。然而，现实表明，许多生成的评论保持不变。因此，它们在清晰度或可维护性方面不会增加代码的价值。不变的生成的XML文档评论只是噪音。从某种意义上说，它们是干涉违反原则的一种形式。

在我的团队中，我们认识到这些“噪音评论”的无用性。但是我们也不想全部“没有评论”的方式。 一个想出了想法是产生这样的存根所有公共成员：

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

构建（我们采用TFS2013）应该打破，如果有人与TODO注释不变的代码检查。

我的问题是：

• 有没有人做过这样的事？怎么样？
• 是否有其他解决XML文档困境的方法？
• 我担心的是，它会减慢团队成员的工作，这些团队成员需要处理现有的无证代码，他们需要做一些代码考古工作，以便能够检查即使很小的变化。任何想法，防止这种情况？

Answer 1

已经有一个内置的规定，但并不理想：

• 不使用评论发电机
• 不要用你提出的存根
• 与警戒水平编译= 4
• 检查[X] XML文档文件
• 检查[X]将警告视为错误