我能得到一份关于缺少 XML 文档的报告吗答案

【问题标题】：Can I get a report on missing XML documentation我能得到一份关于缺少 XML 文档的报告吗
【发布时间】：2016-12-21 09:52:47
【问题描述】：

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

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

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

【问题讨论】：

当我意识到如果可以从类、方法或参数名称自动生成它们时，我停止使用自动生成的 cmets，那么它们就毫无意义了……但是，如果您打开 XML 注释生成，那么您应该为没有 XML 文档的公共方法、类和属性获取编译器警告。
是的，我知道，我收到“警告 CS1591：缺少公开可见类型或成员的 XML 注释”，但是我现在不知道如何从构建输出中仅提取这些警告。

标签： c# xml visual-studio-2015 stylecop ghostdoc

【解决方案1】：

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

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

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

GhostDoc 和 CodeIt.Right 都会为丢失的文档生成 XML 注释模板，但当然，您需要在之后对其进行编辑。

【讨论】：