c# - 我能得到一份关于缺少 XML 文档的报告吗

Question

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

GhostDoc Pro 似乎运行良好，除了我无法获得有关覆盖率的报告，或者至少无法获得完全缺乏文档的类。

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

Answer 1

就像您提到的，GhostDoc 将帮助您解决此问题；您可能只需要更新的版本或正确的版本。

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

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

GhostDoc 和 CodeIt.Right 都会为丢失的文档生成 XML 注释模板，但是，当然，您想在之后编辑它们。