规则类别
每个代码分析规则都属于某种规则类别。 例如,设计规则支持遵从 .NET 设计准则,而安全规则可帮助防止出现安全漏洞。 你可为整个规则类别配置严重性级别。 还可以按类别配置其他选项。
下表显示了不同的代码分析规则类别,并提供指向每个类别中的规则的链接。 它还列出了 EditorConfig 文件中要使用的配置值,以按类别批量配置规则严重性。 例如,若要将安全规则冲突的严重性设置为错误,则 EditorConfig 条目将为 dotnet_analyzer_diagnostic.category-Security.severity = error
。
提示
使用 dotnet_analyzer_diagnostic.category-<category>.severity
语法设置一类规则的严重性并不适用于默认禁用的规则。 但是,从 .NET 6 开始,可以使用 AnalysisMode<Category> 项目属性启用某一类别中的所有规则。
设计规则
|
值 |
规则链接 |
设计规则 |
描述 |
设计规则支持遵从框架设计准则。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Design.severity |
MSBuild 属性值 |
<AnalysisModeDesign> |
文档规则
|
值 |
规则链接 |
文档规则 |
描述 |
文档规则支持通过正确为外部可见的 API 使用 XML 文档注释来编写记录详尽的库。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Documentation.severity |
MSBuild 属性值 |
<AnalysisModeDocumentation> |
全球化规则
|
值 |
规则链接 |
全球化规则 |
描述 |
全球化规则支持世界通用库和应用程序。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Globalization.severity |
MSBuild 属性值 |
<AnalysisModeGlobalization> |
可移植性和互操作性规则
|
值 |
规则链接 |
可移植性和互操作性规则 |
描述 |
可移植性规则支持跨不同平台的可移植性。 互操作性规则支持与 COM 客户端交互。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Interoperability.severity |
MSBuild 属性值 |
<AnalysisModeInteroperability> |
可维护性规则
|
值 |
规则链接 |
可维护性规则 |
描述 |
可维护性规则支持库和应用程序维护。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Maintainability.severity |
MSBuild 属性值 |
<AnalysisModeMaintainability> |
命名规则
|
值 |
规则链接 |
命名规则 |
描述 |
命名规则支持遵从 .NET 设计准则的命名约定。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Naming.severity |
MSBuild 属性值 |
<AnalysisModeNaming> |
|
值 |
规则链接 |
性能规则 |
描述 |
性能规则支持高性能库和应用程序。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Performance.severity |
MSBuild 属性值 |
<AnalysisModePerformance> |
单文件规则
|
值 |
规则链接 |
单文件规则 |
描述 |
单文件规则支持单文件应用程序。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-SingleFile.severity |
MSBuild 属性值 |
<AnalysisModeSingleFile> |
可靠性规则
|
值 |
规则链接 |
可靠性规则 |
描述 |
支持库和应用程序可靠性(例如正确使用内存和线程)的可靠性规则。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Reliability.severity |
MSBuild 属性值 |
<AnalysisModeReliability> |
安全规则
|
值 |
规则链接 |
安全规则 |
描述 |
安全规则支持更安全的库和应用程序。 这些规则有助于防止程序出现安全漏洞。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Security.severity |
MSBuild 属性值 |
<AnalysisModeSecurity> |
样式规则
|
值 |
规则链接 |
样式规则 |
描述 |
样式规则支持代码库中的代码样式保持一致。 这些规则以“IDE”前缀开头。* |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Style.severity |
MSBuild 属性值 |
<AnalysisModeStyle> |
* 请使用 EditorConfig 值 dotnet_analyzer_diagnostic.category-CodeQuality.severity
来启用以下规则:IDE0051、IDE0052、IDE0064 和 IDE0076。 虽然这些规则以“IDE”开头,但从技术上讲,它们并不属于 Style
类别。
用法规则
|
值 |
规则链接 |
用法规则 |
描述 |
使用规则支持 .NET 的正确用法。 |
EditorConfig 值 |
dotnet_analyzer_diagnostic.category-Usage.severity |
MSBuild 属性值 |
<AnalysisModeUsage> |