Partage via


Catégories de règles

Chaque règle d’analyse du code appartient à une catégorie de règles. Par exemple, les règles de conception prennent en charge l’adhésion aux instructions de conception .NET et les règles de sécurité permettent d’éviter les failles de sécurité. Vous pouvez configurer le niveau de gravité pour une catégorie entière de règles. Vous pouvez également configurer des options supplémentaires par catégorie.

Le tableau suivant présente les différentes catégories de règles d’analyse du code et fournit un lien vers les règles de chaque catégorie. Il répertorie également la valeur de configuration à utiliser dans un fichier EditorConfig pour configurer en bloc la gravité de la règle par catégorie. Par exemple, pour définir la gravité des violations de règle de sécurité comme étant des erreurs, l’entrée EditorConfig est dotnet_analyzer_diagnostic.category-Security.severity = error.

Conseil / Astuce

La définition de la gravité d’une catégorie de règles à l’aide de la dotnet_analyzer_diagnostic.category-<category>.severity syntaxe ne s’applique pas aux règles désactivées par défaut. Toutefois, à partir de .NET 6, vous pouvez utiliser la propriété de projet AnalysisMode<Category> pour activer toutes les règles d’une catégorie.

Règles de conception

Valeur
Lien vers des règles Règles de conception
Description Les règles de conception prennent en charge l’adhésion aux instructions de conception du framework.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Design.severity
Valeur de propriété MSBuild <AnalysisModeDesign>

Règles de documentation

Valeur
Lien vers des règles Règles de documentation
Description Les règles de documentation prennent en charge l’écriture de bibliothèques bien documentées via l’utilisation correcte des commentaires de documentation XML pour les API visibles en externe.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Documentation.severity
Valeur de propriété MSBuild <AnalysisModeDocumentation>

Règles de globalisation

Valeur
Lien vers des règles Règles de globalisation
Description Les règles de la mondialisation soutiennent les bibliothèques et les applications prêtes à être utilisées dans le monde entier.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Globalization.severity
Valeur de propriété MSBuild <AnalysisModeGlobalization>

Règles de portabilité et d’interopérabilité

Valeur
Lien vers des règles Règles de portabilité et d’interopérabilité
Description Les règles de portabilité prennent en charge la portabilité sur différentes plateformes. Les règles d’interopérabilité prennent en charge l’interaction avec les clients COM.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Interoperability.severity
Valeur de propriété MSBuild <AnalysisModeInteroperability>

Règles de maintenance

Valeur
Lien vers des règles Règles de maintenabilité
Description Les règles de maintenance prennent en charge la maintenance des bibliothèques et des applications.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Maintainability.severity
Valeur de propriété MSBuild <AnalysisModeMaintainability>

Règles de dénomination

Valeur
Lien vers des règles Règles d’affectation de noms
Description Les règles d’affectation de noms prennent en charge l’adhésion aux conventions d’affectation de noms des instructions de conception .NET.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Naming.severity
Valeur de propriété MSBuild <AnalysisModeNaming>

Règles de performances

Valeur
Lien vers des règles Règles de performances
Description Les règles de performances prennent en charge les bibliothèques et applications hautes performances.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Performance.severity
Valeur de propriété MSBuild <AnalysisModePerformance>

Règles SingleFile

Valeur
Lien vers des règles Règles SingleFile
Description Les règles à fichier unique prennent en charge les applications à fichier unique.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-SingleFile.severity
Valeur de propriété MSBuild <AnalysisModeSingleFile>

Règles de fiabilité

Valeur
Lien vers des règles Règles de fiabilité
Description Règles de fiabilité gérant la fiabilité des bibliothèques et des applications, notamment une utilisation adaptée des threads et de la mémoire.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Reliability.severity
Valeur de propriété MSBuild <AnalysisModeReliability>

Règles de sécurité

Valeur
Lien vers des règles Règles de sécurité
Description Les règles de sécurité prennent en charge des bibliothèques et des applications plus sécurisées. Ces règles permettent d’éviter les failles de sécurité dans votre programme.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Security.severity
Valeur de propriété MSBuild <AnalysisModeSecurity>

Règles de style

Valeur
Lien vers des règles Règles de style
Description Les règles de style prennent en charge le style de code cohérent dans votre codebase. Ces règles commencent par le préfixe « IDE ».*
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Style.severity
Valeur de propriété MSBuild <AnalysisModeStyle>

* Utilisez la valeur dotnet_analyzer_diagnostic.category-CodeQuality.severity EditorConfig pour activer les règles suivantes : IDE0051, IDE0052, IDE0064 et IDE0076. Bien que ces règles commencent par « IDE », elles ne font pas partie techniquement de la Style catégorie.

Règles d’utilisation

Valeur
Lien vers des règles Règles d’utilisation
Description Les règles d’utilisation prennent en charge l’utilisation appropriée de .NET.
Valeur EditorConfig dotnet_analyzer_diagnostic.category-Usage.severity
Valeur de propriété MSBuild <AnalysisModeUsage>