Cada regra de análise de código pertence a uma categoria de regras. Por exemplo, as regras de design suportam a adesão às diretrizes de design do .NET e as regras de segurança ajudam a evitar falhas de segurança. Você pode configurar o nível de gravidade para uma categoria inteira de regras. Você também pode configurar opções adicionais por categoria.
A tabela a seguir mostra as diferentes categorias de regras de análise de código e fornece um link para as regras em cada categoria. Ele também lista o valor de configuração a ser usado em um arquivo EditorConfig para configurar em massa a gravidade da regra por categoria. Por exemplo, para definir a gravidade das violações de regras de segurança como erros, a entrada EditorConfig é dotnet_analyzer_diagnostic.category-Security.severity = error.
Sugestão
Definir a severidade para uma categoria de regras usando a dotnet_analyzer_diagnostic.category-<category>.severity sintaxe não se aplica a regras desabilitadas por padrão. No entanto, a partir do .NET 6, você pode usar a propriedade de projeto AnalysisMode<Category> para habilitar todas as regras em uma categoria.
Regras de conceção
Regras de documentação
|
Valor |
|
Ligação às regras |
Regras de documentação |
|
Descrição |
As regras de documentação suportam a escrita de bibliotecas bem documentadas através do uso correto de comentários de documentação XML para APIs visíveis externamente. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Documentation.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeDocumentation> |
Regras de globalização
|
Valor |
|
Ligação às regras |
Regras de globalização |
|
Descrição |
As regras de globalização suportam bibliotecas e aplicativos prontos para o mundo. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Globalization.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeGlobalization> |
Regras de portabilidade e interoperabilidade
|
Valor |
|
Ligação às regras |
Regras de portabilidade e interoperabilidade |
|
Descrição |
As regras de portabilidade suportam a portabilidade entre diferentes plataformas. As regras de interoperabilidade suportam a interação com clientes COM. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Interoperability.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeInteroperability> |
Regras de manutenibilidade
|
Valor |
|
Ligação às regras |
Regras de manutenibilidade |
|
Descrição |
As regras de manutenibilidade suportam a manutenção de bibliotecas e aplicativos. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Maintainability.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeMaintainability> |
Regras de nomenclatura
|
Valor |
|
Ligação às regras |
Regras de nomenclatura |
|
Descrição |
As regras de nomenclatura oferecem suporte à adesão às convenções de nomenclatura das diretrizes de design do .NET. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Naming.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeNaming> |
|
Valor |
|
Ligação às regras |
Regras de desempenho |
|
Descrição |
As regras de desempenho suportam bibliotecas e aplicativos de alto desempenho. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Performance.severity |
|
Valor da propriedade MSBuild |
<AnalysisModePerformance> |
Regras do SingleFile
|
Valor |
|
Ligação às regras |
Regras do SingleFile |
|
Descrição |
As regras de arquivo único suportam aplicativos de arquivo único. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-SingleFile.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeSingleFile> |
Regras de fiabilidade
|
Valor |
|
Ligação às regras |
Regras de fiabilidade |
|
Descrição |
As regras de confiabilidade oferecem suporte à confiabilidade da biblioteca e do aplicativo, como o uso correto de memória e thread. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Reliability.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeReliability> |
Regras de segurança
|
Valor |
|
Ligação às regras |
Regras de segurança |
|
Descrição |
As regras de segurança suportam bibliotecas e aplicações mais seguras. Estas regras ajudam a evitar falhas de segurança no seu programa. |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Security.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeSecurity> |
Regras de estilo
|
Valor |
|
Ligação às regras |
Regras de estilo |
|
Descrição |
As regras de estilo suportam um estilo de código consistente na sua base de código. Essas regras começam com o prefixo "IDE".* |
|
Valor do EditorConfig |
dotnet_analyzer_diagnostic.category-Style.severity |
|
Valor da propriedade MSBuild |
<AnalysisModeStyle> |
* Use o valor dotnet_analyzer_diagnostic.category-CodeQuality.severity EditorConfig para habilitar as seguintes regras: IDE0051, IDE0052, IDE0064 e IDE0076. Embora essas regras comecem com "IDE", elas não são tecnicamente parte da Style categoria.
Regras de utilização