Visual Studio 中针对托管代码的旧版分析概述
Visual Studio 可以通过两种方式对托管代码执行代码分析:第一种是旧版分析(即托管程序集的 FxCop 静态分析),第二种是较为新式的基于 .NET Compiler Platform 的代码分析器。 本主题介绍旧版分析。 若要详细了解基于 .NET Compiler Platform 的代码分析,请参阅基于 .NET Compiler Platform 的分析器概述。
托管代码的代码分析用于分析托管程序集并报告程序集的相关信息,例如 .NET 设计准则中规定的编程和设计规则的冲突。
分析工具将它在分析期间执行的检查表示为警告消息。 警告消息标识任何相关的编程和设计问题,如有可能,还提供有关如何修复问题的信息。
注意
Visual Studio 中的 .NET Core 和 .NET Standard 项目不支持旧版分析(静态代码分析)。 如果在 .NET Core 或 .NET Standard 项目上作为 msbuild 的一部分运行代码分析,将看到如下所示的错误:“错误: CA0055: 无法识别 <your.dll> 的平台”。 若要分析 .NET Core 或 .NET Standard 项目中的代码,请改用代码分析器。
集成开发环境 (IDE) 集成
可对项目手动或自动运行代码分析。
若要在每次生成项目时都运行代码分析,请在项目的“Code Analysis”属性页上选择相应的选项。 有关详细信息,请参阅如何:启用和禁用自动代码分析。
若要对项目手动运行代码分析,请从菜单栏中选择“分析”>“运行代码分析”>“在 <project> 上运行代码分析”。
规则集
托管代码的代码分析规则划分到规则集中。 可使用某个 Microsoft 标准规则集,也可创建自定义规则集来满足特定需求。
禁止显示警告
它通常用于指示警告不适用。 这样,便可以通知开发人员以及可能会在以后评审代码的其他人员:已调查了一个警告,且禁止显示或忽略了该警告。
在源代码中禁止显示警告是通过自定义特性实现的。 若要禁止显示警告,请向源代码添加特性 SuppressMessage
,如下面的示例所示:
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1039:ListsAreStrongTyped")]
Public class MyClass
{
// code
}
有关详细信息,请参阅取消警告。
注意
如果将项目迁移到 Visual Studio 2019,可能会突然看到大量代码分析警告。 如果尚未准备好处理警告,可选择“分析”>“生成并禁止显示待处理的问题”来禁止显示所有警告 。
作为签入策略的一部分运行代码分析
作为一个单位,可能希望所有签入行为满足特定的策略。 特别是希望确保遵从下列策略:
要签入的代码中没有生成错误。
在最近一次生成中运行了代码分析。
可以通过指定签入策略来实现该任务。 有关详细信息,请参阅利用项目签入策略提高代码质量。
Team Build 集成
你可以使用生成系统的集成功能在生成过程中运行分析工具。 有关详细信息,请参阅 Azure Pipelines。