使用 Visual Studio 2010 代码分析检查 XML 代码文档

Posted 2023-04-12

【中文标题】使用 Visual Studio 2010 代码分析检查 XML 代码文档

【英文标题】：XML code documentation checking using Visual Studio 2010 Code Analysis

【发布时间】：2010-09-21 09:13:07

【问题描述】：

我使用 Visual Studio 2010 高级代码分析 (CA) 功能，并在每次编译我的项目时强制使用它们，同时还将警告显示为错误，因此我保持我的代码良好...更好。

但是。

因为这个 CA 非常好，所以我也不想使用 StyleCop。因为 StyleCop 给了我 CA 没有的代码样式规范。

问题

我想知道是否可以将 StyleCop 中的规则合并到 CA 中？ 那是最好的，所以在检查代码本身的同时还要强制执行代码样式。

【参考方案1】：

不可能让 StyleCop 规则在代码分析下工作，因为前者在源代码上运行，而后者在编译的程序集级别上运行。

如果您想尝试CodeIt.Right（披露：这是我们的产品），您会发现大量可配置且灵活的规则，这些规则将指出代码样式违规并为您纠正它们。

因此，您可以使用 CodeIt.Right 做什么，如果您只想检查缺少的 XML 代码文档，您可以创建一个自定义配置文件，并且只将 XML 文档规则包含到配置文件中。然后，您可以在 VS IDE 内或作为 CI/Automated Build 过程的一部分根据该配置文件验证代码。

【讨论】：

我不确定您是否正确，因为 CA 还会检查命名约定等。无论如何，这些都不存在于编译代码中。您可能会想到 FxCop，它对已编译的程序集进行代码检查。

其实CA主要是基于FxCop引擎和命名（本地除外）和.NET应用程序中的代码流可以从编译的程序集元数据中检索。要验证这一点，请尝试 CA 查找本地人的命名违规 - 它甚至没有规则，因为这些超出了它的范围:) 只是说...