规则类别

2022-01-09 12:36:09 浏览数 (1)

每个代码分析规则都属于某种规则类别。 例如,设计规则支持遵从 .NET 设计准则,而安全规则可帮助防止出现安全漏洞。 你可为整个规则类别配置严重性级别。 还可以按类别配置其他选项。

下表显示了不同的代码分析规则类别,并提供指向每个类别中的规则的链接。 它还列出了 EditorConfig 文件中要使用的配置值,以按类别批量配置规则严重性。 例如,若要将安全规则冲突的严重性设置为错误,则 EditorConfig 条目将为 dotnet_analyzer_diagnostic.category-Security.severity = error。

提示

使用 dotnet_analyzer_diagnostic.category-<category>.severity 语法设置一类规则的严重性并不适用于默认禁用的规则。 但是,从 .NET 6 开始,可以使用 AnalysisMode<Category> 项目属性启用某一类别中的所有规则。

类别

说明

EditorConfig 值

设计规则

设计规则支持遵从 .NET Framework 设计准则。

dotnet_analyzer_diagnostic.category-Design.severity

文档规则

文档规则支持通过对外部可见的 API 正确使用 XML 文档注释来编写记录详尽的库。

dotnet_analyzer_diagnostic.category-Documentation.severity

全球化规则

全球化规则支持世界通用库和应用程序。

dotnet_analyzer_diagnostic.category-Globalization.severity

可移植性和互操作性规则

可移植性规则支持跨不同平台的可移植性。 互操作性规则支持与 COM 客户端交互。

dotnet_analyzer_diagnostic.category-Interoperability.severity

可维护性规则

可维护性规则支持库和应用程序维护。

dotnet_analyzer_diagnostic.category-Maintainability.severity

命名规则

命名规则支持遵从 .NET 设计准则的命名约定。

dotnet_analyzer_diagnostic.category-Naming.severity

性能规则

性能规则支持高性能库和应用程序。

dotnet_analyzer_diagnostic.category-Performance.severity

单文件规则

单文件规则支持单文件应用程序。

dotnet_analyzer_diagnostic.category-SingleFile.severity

可靠性规则

可靠性规则支持库和应用程序可靠性(例如正确使用内存和线程)。

dotnet_analyzer_diagnostic.category-Reliability.severity

安全规则

安全规则支持更安全的库和应用程序。 这些规则有助于防止程序出现安全漏洞。

dotnet_analyzer_diagnostic.category-Security.severity

样式规则

样式规则支持代码库中的代码样式保持一致。 这些规则以“IDE”前缀开头。

dotnet_analyzer_diagnostic.category-Style.severity

用法规则

用法规则支持正确使用 .NET。

dotnet_analyzer_diagnostic.category-Usage.severity

空值

你可以使用此 EditorConfig 值启用以下规则:IDE0051、IDE0064、IDE0076。 当这些规则以“IDE”开头时,它们在技术上不是 Style 类别的一部分。

dotnet_analyzer_diagnostic.category-CodeQuality.severity

0 人点赞