代码分析

可以使用代码分析器查找 .NET Framework 应用程序代码中的潜在问题。 分析器会发现潜在问题,并建议修复方法。

在编写代码或 CI 生成过程中,基于 Roslyn 的代码分析器在 Visual Studio 中以交互方式运行。 应在开发周期中尽早将分析器添加到项目中。 在代码中发现任何潜在问题越早,它们就越容易解决。 分析器会在现有代码中标记问题,并在继续开发时警告新问题。

注释

本文利用现已弃用 的 Microsoft.NetFramework.Analyzers NuGet 包。 从 .NET 5 开始,.NET 分析器包含在 .NET SDK 中。 如果需要,可以改用 Microsoft.CodeAnalysis.NetAnalyzers NuGet 包 。 有关详细信息,请参阅 .NET 中的代码分析

安装和配置分析器

.NET Framework 分析器在 Microsoft.NetFramework.Analyzers NuGet 包中交付。 此包提供特定于 .NET Framework API 的分析器,其中包括安全分析器。 包包含在 Microsoft.CodeAnalysis.FxCopAnalyzers 包中,因此,如果安装该包,则无需单独安装 .NET Framework 分析器。

在希望分析器运行的每个项目上安装 NuGet 包。 只有一名开发人员需要将它们添加到项目中。 分析器包是项目依赖项,一旦有了更新的解决方案,就会在每个开发人员的计算机上运行。

若要安装包,请右键单击项目,然后选择“管理依赖项”。 在 NuGet 资源管理器中,搜索“Microsoft.NetFramework.Analyzers”。 在解决方案中的所有项目中安装最新的稳定版本。

使用分析器

安装 NuGet 包后,生成解决方案。 分析器将报告它在代码库中找到的任何问题。 在 Visual Studio 错误列表窗口中,这些问题被报告为警告,如下图所示:

.NET Framework 分析器报告的问题。

编写代码时,代码中所有的潜在问题下方都会有波浪线。 将鼠标悬停在任何问题上以获取更多信息,并查看有关任何可能修复的建议,如下图所示:

代码分析器发现的问题的交互式报告。

有关详细信息,请参阅 Visual Studio 中的代码分析

规则类型

分析器检查解决方案中的代码,并显示带有 CA 前缀的警告。 有关所有可能警告的列表,请参阅 代码质量规则。 只有其中一些警告适用于 .NET Framework APIS,包括:

另请参阅