我可以得到有关丢失 XML 文档的报告吗

Question

我正在试用 GhostDoc、StyleCop、CodeIt.Right、FXCop 等，以找到一种简化的方式来添加自动生成的 XML-C# 代码中的注释以及在参数更改时更新现有注释例如。

GhostDoc Pro 似乎运行良好，除了我无法获得覆盖率报告这一事实，或者至少 类 完全没有文档。

我怎样才能得到这样的报告？

Answer 1

就像你提到的，GhostDoc 会帮你解决这个问题；您可能只需要更新版本或正确的版本。

您可以使用 v5 中的 GhostDoc Pro 文档维护功能 - 它会帮助您查找自动生成的文档，查找 classes/methods 缺少的文档，以及需要更新的文档（方法签名出来同步）或编辑。以下是有关 v5 功能的更多信息 - http://submain.com/blog/ReleasedGhostDocV50.aspx

你提到你也使用 CodeIt.Right - 你想打开规则 GE00005 - 外部可见的类型和成员应该有 XML 评论（类型，成员 -> 应该有 XML注释）。您还可以在 VS 中导出列表或在您的构建中生成它。

GhostDoc 和 CodeIt.Right 都会为缺失的文档生成 XML 评论模板，但是，当然，您需要之后再编辑它们。