Categorias de regras

Cada regra de análise de código pertence a uma categoria de regras. Por exemplo, as regras de design dão suporte à 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 regra 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 regra de segurança como erros, a entrada no EditorConfig é dotnet_analyzer_diagnostic.category-Security.severity = error.

Dica

Definir a gravidade de uma categoria de regras usando a sintaxe dotnet_analyzer_diagnostic.category-<category>.severity 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 design

	Valor
Link para regras	Regras de design
Descrição	As regras de design dão suporte à adesão às diretrizes de design do Framework.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Design.severity
Valor da propriedade do MSBuild	<AnalysisModeDesign>

Regras de documentação

	Valor
Link para regras	Regras de documentação
Descrição	As regras de documentação dão suporte à gravação de bibliotecas bem documentadas por meio do uso correto de comentários de documentação XML para APIs externamente visíveis.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Documentation.severity
Valor da propriedade do MSBuild	<AnalysisModeDocumentation>

Regras de globalização

	Valor
Link para regras	Regras de globalização
Descrição	As regras de globalização dão suporte a bibliotecas e aplicativos avançados.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Globalization.severity
Valor da propriedade do MSBuild	<AnalysisModeGlobalization>

Regras de portabilidade e interoperabilidade

	Valor
Link para regras	Regras de portabilidade e interoperabilidade
Descrição	As regras de portabilidade dão suporte à portabilidade em diferentes plataformas. As regras de interoperabilidade dão suporte à interação com clientes COM.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Interoperability.severity
Valor da propriedade do MSBuild	<AnalysisModeInteroperability>

Regras de facilidade de manutenção

	Valor
Link para regras	Regras de facilidade de manutenção
Descrição	As regras de manutenção dão suporte à biblioteca e à manutenção de aplicativos.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Maintainability.severity
Valor da propriedade do MSBuild	<AnalysisModeMaintainability>

Regras de nomenclatura

	Valor
Link para regras	Regras de nomenclatura
Descrição	As regras de nomenclatura dão suporte à adesão às convenções de nomenclatura das diretrizes de design do .NET.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Naming.severity
Valor da propriedade do MSBuild	<AnalysisModeNaming>

Regras de desempenho

	Valor
Link para regras	Regras de desempenho
Descrição	As regras de desempenho dão suporte a bibliotecas e aplicativos de alto desempenho.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Performance.severity
Valor da propriedade do MSBuild	<AnalysisModePerformance>

Regras de Arquivo único

	Valor
Link para regras	Regras de Arquivo único
Descrição	As regras de arquivo único dão suporte a aplicativos de arquivo único.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-SingleFile.severity
Valor da propriedade do MSBuild	<AnalysisModeSingleFile>

Regras de confiabilidade

	Valor
Link para regras	Regras de confiabilidade
Descrição	As regras de confiabilidade dão suporte à confiabilidade de biblioteca e de aplicativo, como o uso correto de memória e de thread.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Reliability.severity
Valor da propriedade do MSBuild	<AnalysisModeReliability>

Regras de segurança

	Valor
Link para regras	Regras de segurança
Descrição	As regras de segurança dão suporte a bibliotecas e aplicativos mais seguros. Essas regras ajudam a evitar falhas de segurança em seu programa.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Security.severity
Valor da propriedade do MSBuild	<AnalysisModeSecurity>

Regras de estilo

	Valor
Link para regras	Regras de estilo
Descrição	As regras de estilo dão suporte ao estilo de código consistente em sua base de código. Essas regras começam com o prefixo "IDE".*
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Style.severity
Valor da propriedade do MSBuild	<AnalysisModeStyle>

*Use o valor EditorConfig dotnet_analyzer_diagnostic.category-CodeQuality.severity para habilitar as seguintes regras: IDE0051, IDE0052, IDE0064, e IDE0076. Embora essas regras comecem com "IDE", elas não fazem parte tecnicamente da categoria Style.

Regras de uso

	Valor
Link para regras	Regras de uso
Descrição	As regras de uso dão suporte ao uso adequado do .NET.
valor da EditorConfig	dotnet_analyzer_diagnostic.category-Usage.severity
Valor da propriedade do MSBuild	<AnalysisModeUsage>