FxCop 或其他实用程序需要 VB.NET 中的内联文档？ [关闭]

Posted 2023-02-16

【中文标题】FxCop 或其他实用程序需要 VB.NET 中的内联文档？ [关闭]

【英文标题】：FxCop or other util to require inline docs in VB.NET? [closed]

【发布时间】：2009-12-11 17:24:59

【问题描述】：

我正在开始一个新项目；试图比以前的更严格。我已将警告设置为构建中的错误我已将 FxCop 添加到 PostBuild。我列表中的最后一件事要求人们为所有类/非私有方法/属性添加内联文档。

是否有自定义 FxCop 规则或我可以在后期构建中运行以检查的其他 exe？我很难找到一些东西，这很令人惊讶。

【问题讨论】：

编译器是否不会针对非私有成员/类上缺少的文档发出警告，这会导致您的设置出错？还是 vb.net 不这样做？ C# 编译器可以。无论如何，+1 表示真的试图在下一个项目中做得更好。

仅在 C# 中。我真的很讨厌 MS 总是在 C# 和 VB.NET 项目之间做这样不同的事情。

【参考方案1】：

宾果游戏：http://www.ookii.org/software/xmlcommentchecker/

【讨论】：

不，下一个技巧是弄清楚如何将其警告转变为构建破坏失败。

就我而言，重新编译源代码以在控制台中输出错误而不是警告。然后构建失败。

【参考方案2】：

VB.NET 编译器在这方面没有多大帮助，因为我只见过它在函数中没有名为“foo”的参数时发出类似<param name="foo">...</param> 的警告，但是没有标签，这很烦人。

我在我的项目中使用的方法是使用来自 Sandcastle 的构建日志并将其 grep 用于它吐出的警告，因为它们很容易匹配（它们都以“警告：ShowMissingComponent：”之类的内容开头它会针对您代码中的各种缺失标签发出警告。