我可以获得缺少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注释（类型，成员 - ＆gt;应具有XML注释）。您也可以在VS中导出列表或在构建中生成列表。

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