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 le respect des directives de conception .NET, et les règles de sécurité permettent de prévenir les failles de sécurité. Vous pouvez configurer le niveau de gravité pour toute une catégorie de règles. Vous pouvez aussi configurer des options supplémentaires pour chaque catégorie individuelle.

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 liste aussi la valeur de configuration à utiliser dans un fichier EditorConfig pour configurer en bloc la gravité des règles par catégorie. Par exemple, pour définir la gravité des violations de règles de sécurité comme étant des erreurs, l’entrée de EditorConfig est dotnet_analyzer_diagnostic.category-Security.severity = error.

Conseil

La définition de la gravité d’une catégorie de règles en utilisant la syntaxe dotnet_analyzer_diagnostic.category-<category>.severity ne s’applique pas aux règles qui sont désactivées par défaut. Cependant, à compter 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 les règles Règles de conception
Description Les règles de conception aident au respect des Directives de conception de Framework.
Valeur de EditorConfig dotnet_analyzer_diagnostic.category-Design.severity
Valeur de propriété MSBuild <AnalysisModeDesign>

Règles de documentation

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

Règles de globalisation

Valeur
Lien vers les règles Règles de globalisation
Description Les règles de globalisation aident à créer des applications et des bibliothèques universelles.
Valeur de EditorConfig dotnet_analyzer_diagnostic.category-Globalization.severity
Valeur de propriété MSBuild <AnalysisModeGlobalization>

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

Valeur
Lien vers les 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 de EditorConfig dotnet_analyzer_diagnostic.category-Interoperability.severity
Valeur de propriété MSBuild <AnalysisModeInteroperability>

Règles de maintenabilité

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

Règles d’affectation des noms

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

Règles de performances

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

Règles SingleFile

Valeur
Lien vers les règles Règles SingleFile
Description Les règles relatives à un fichier unique aident à créer des applications à fichier unique.
Valeur de EditorConfig dotnet_analyzer_diagnostic.category-SingleFile.severity
Valeur de propriété MSBuild <AnalysisModeSingleFile>

Règles de fiabilité

Valeur
Lien vers les 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 de EditorConfig dotnet_analyzer_diagnostic.category-Reliability.severity
Valeur de propriété MSBuild <AnalysisModeReliability>

Règles de sécurité

Valeur
Lien vers les règles Règles de sécurité
Description Les règles de sécurité aident à obtenir des bibliothèques et des applications plus sûres. Ces règles aident à prévenir les failles de sécurité dans votre programme.
Valeur de EditorConfig dotnet_analyzer_diagnostic.category-Security.severity
Valeur de propriété MSBuild <AnalysisModeSecurity>

Règles de style

Valeur
Lien vers les règles Règles de style
Description Les règles de style aident à la cohérence du style du dans votre codebase. Ces règles commencent par le préfixe « IDE ».*
Valeur de EditorConfig dotnet_analyzer_diagnostic.category-Style.severity
Valeur de propriété MSBuild <AnalysisModeStyle>

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

Règles d’utilisation

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