强制所有成员的xml评论

Question

对于公众成员，我收到警告“缺少对公开可见类型或成员的XML评论......”。这很好，但还不够。我想为所有（或至少是内部和受保护的）成员启用此警告。

有没有办法获取有关缺少xml注释的警告或信息？运行时是否有任何工具（如Resharper）具有该功能？

Answer 1

如果您使用的是ReSharper，请使用适用于ReSharper的Agent Smith插件。 它是开源的，所以请随意看看他们在那里有什么。

Agent Smith HomePage

Agent Smith source code on Google Code

编辑：Agent Smith在代码编辑器运行时执行xml注释验证（缺少更好的单词）

Answer 2

StyleCop (aka MS SourceAnalysis)可以为您完成此操作。这是team's blog，您可以在其中详细了解它。

Answer 3

结帐StyleCop。它是一个可以集成到您的构建中的Microsoft工具，如果不遵循样式规则，将生成警告或错误。

它有一条规则：“SA1600：ElementsMustBeDocumented”，似乎符合您的要求。