Procédure pas à pas : configuration et utilisation d’un ensemble de règles personnaliséWalkthrough: Configuring and Using a Custom Rule Set

Cette procédure pas à pas montre comment utiliser les outils d’analyse de code qui ont été configurés pour utiliser un texte personnalisé ensemble de règles sur une bibliothèque de classes.This walkthrough shows how to use code analysis tools that have been configured to use a customized rule set on a class library. Vous pouvez sélectionner un ensemble de règles relatives au type de projet que vous avez spécifié pour votre solution, ou vous pouvez sélectionner les autres ensembles de règles pour répondre à un besoin spécifique, comme l’analyse du code hérité pour les problèmes qui peuvent être résolus de façon permanente.You can select a rule set that relates to the project type that you specified for your solution, or you can select alternative rule sets to fulfill a specific need such as scanning legacy code for issues that can be fixed in a nonbreaking way. Dans les deux cas, les ensembles de règles peuvent également être personnalisées pour les adapter précisément aux besoins de votre projet.In either case, the rule sets can also be customized to fine tune them to your project requirements.

Dans cette procédure pas à pas, vous allez effectuer ces processus :In this walkthrough, you will step through these processes:

  • Créer une bibliothèque de classes.Create a class library.

  • Sélectionnez le règles de conception de base Microsoft ensemble de règles d’analyse du Code.Select the Microsoft Basic Design Guideline Rules Code Analysis rule set.

  • Ajoutez votre propre code à la classe.Add your own code to the class.

  • Exécuter l’analyse du Code.Run Code Analysis.

  • Personnaliser l’ensemble de règles.Customize the rule set.

  • Exécuter l’analyse du Code et voir la configuration de la règle fonctionne de comportement de personnalisation.Run Code Analysis and see how the rule set customization behavior works.

À l’aide de la règle définit avec l’analyse du CodeUsing Rule Sets with Code Analysis

Commencez par créer une bibliothèque de classes simple.First, create a simple class library.

Créer une bibliothèque de classesCreate a class library

  1. Dans le menu Fichier , cliquez sur Nouveau , puis sur Projet.On the File menu, click New and then click Project.

  2. Dans le nouveau projet boîte de dialogue Types de projets, cliquez sur Visual C#.In the New Project dialog box, under Project Types, click Visual C#.

  3. Sous Visual C#, sélectionnez bibliothèque de classes.Under Visual C#, select Class Library.

  4. Dans le nom zone de texte, tapez RuleSetSample puis cliquez sur OK.In the Name text box, type RuleSetSample and then click OK.

    Ensuite, vous allez sélectionner la règles de conception de base Microsoft ensemble de règles et l’enregistrer avec votre projet.Next, you will select the Microsoft Basic Design Guideline Rules rule set and save it with your project.

Sélectionnez un ensemble de règles code analysisSelect a code analysis rule set

  1. Sur le analyser menu, cliquez sur configurer l’analyse du Code pour RuleSetSample.On the Analyze menu, click Configure Code Analysis for RuleSetSample.

    Les paramètres de configuration pour l’analyse du Code s’affichent.The configuration settings for Code Analysis appear.

  2. Dans le exécuter cet ensemble de règles la liste déroulante, sélectionnez toutes les règles Microsoft.In the Run this rule set drop-down list, select Microsoft All Rules.

    Pour plus d’informations sur les ensembles de règles disponibles, consultez règle d’analyse du Code définie référence.For more information about the available rule sets, see Code analysis rule set reference.

    Dans le menu fichier, cliquez sur enregistrer les éléments sélectionnés pour mettre à jour le fichier projet avec plus d’informations sur l’ensemble de règles que vous avez sélectionné et ses paramètres.On the File menu, click Save Selected Items to update the project file with information about the rule set that you selected and its settings.

    Conseil

    Dans une situation réelle, il est conseillé de pour hiérarchiser les problèmes que vous souhaitez cibler avec l’analyse du code pour commencer le règles minimales recommandées ensemble de règles et corriger les problèmes de votre choisis, puis ajouter de façon incrémentielle des règles ou une règle définit pour rechercher et corriger les problèmes supplémentaires.In a real-world situation, a good practice to use for prioritizing which issues you want to target with code analysis is to start with the Minimum Recommended Rules rule set and correct the desired issues, and then incrementally add more rules or rule sets to find and correct the additional issues.

    Ensuite, vous allez ajouter du code à la bibliothèque de classes qui sera utilisée pour illustrer les violations de la CA1704 « Identificateurs doivent être correctement orthographiés » règle d’analyse du Code.Next, you will add some code to the class library which will be used to demonstrate violations of the CA1704 "Identifiers should be spelled correctly" Code Analysis rule. Pour plus d’informations, consultez CA1704 : les identificateurs doivent être correctement orthographiés.For more information, see CA1704: Identifiers should be spelled correctly.

Ajoutez votre propre codeAdd your own code

  • Dans l’Explorateur de solutions, ouvrez le fichier Class1.cs et remplacez le code existant avec les éléments suivants :In Solution Explorer, open the Class1.cs file and replace the existing code with the following:

    using System;  
    using System.Collections.Generic;  
    using System.Text;  
    
    namespace RuleSetSample  
    {  
        public class Class1  
        {  
            //The variable parameter names "a" and "b" will cause  
            //the warning CA 1704 Microsoft.Naming "Consider   
            //providing a more meaningful name" to fire  
            public int AddIntegers(int a, int b)  
            {  
    
                int sum = a + b;  
    
                return (sum);  
            }  
        }  
    }
    

Vous pouvez maintenant exécuter l’analyse du Code sur le projet RuleSetSample et recherchez les erreurs et les avertissements générés dans la fenêtre liste d’erreurs.Now you can run Code Analysis on the RuleSetSample project and look for any errors and warnings generated in the Error List window.

Exécuter l’analyse du Code sur le projet RuleSetSampleRun Code Analysis on the RuleSetSample project

  1. Sur le analyser menu, cliquez sur exécuter l’analyse du Code sur RuleSetSample.On the Analyze menu, click Run Code Analysis on RuleSetSample.

  2. Dans la fenêtre liste d’erreurs, cliquez sur avertissements puis cliquez sur le Description en-tête de colonne pour trier les avertissements dans l’ordre alphanumérique.In the Error List window, click Warnings and then click the Description column header to sort the warnings alphanumerically.

    Dans une application réelle, vous serez corriger toute violation de règle à ce stade, ou si vous le souhaitez désactiver ou supprimer une règle si vous avez déterminé qu’il n’a pas impératif de les corriger.In a real-world application, you would fix any rule violations worth fixing at this point, or optionally turn off or suppress a rule if you determined that it was not worth fixing. Pour plus d’informations, consultez supprimer les avertissements.For more information, see Suppress warnings.

  3. Notez que les avertissements CA1704.Notice the CA1704 warnings. Les violations de cette règle indiquent que « pensez en fournissant un nom plus significatif pour les paramètres. »These violations on this rule indicate that you should " Consider providing a more meaningful name for the parameters." Vous pouvez corriger le problème dans votre code, ou vous pouvez désactiver la règle, comme expliqué dans la procédure suivante.You could correct the issue in your code or you can disable the rule, as explained in the next procedure.

    Ensuite, vous allez personnaliser l’ensemble de règles pour exclure l’avertissement CA1704, « Identificateurs doit être correcte ».Next, you will customize the rule set to exclude the CA1704 warning, " Identifiers should be spelled correctly".

Personnaliser l’ensemble de règles pour votre projet désactiver une règle spécifiqueCustomize the rule set for your project to disable a specific rule

  1. Sur le analyser menu, cliquez sur configurer l’analyse du Code pour RuleSetSample.On the Analyze menu, click Configure Code Analysis for RuleSetSample.

  2. Dans le exécuter cet ensemble de règles déroulante liste, vérifiez que le toutes les règles Microsoft est encore sélectionné de la règle, puis cliquez sur ouvrir.In the Run this rule set drop-down list, verify that the Microsoft All Rules rule set is still highlighted and then click Open. La page de jeu de règles s’affiche.The rule set page is displayed.

  3. Développez le nœud de catégorie Microsoft.Naming, puis sélectionnez l’avertissement CA1704.Expand the Microsoft.Naming category node, and then select the CA1704 warning.

  4. Sous le Action colonne, sélectionnez None.Under the Action column, select None. Cela empêche CA1704 de s’afficher comme un avertissement ou une erreur dans la fenêtre liste d’erreurs.This prevents CA1704 from displaying as an warning or error in the Error List window.

    Maintenant est judicieux de faire des essais avec différents boutons de barre d’outils et pour vous familiariser avec les options de filtrage.Now is a good time to experiment with the various toolbar buttons and filtering options to become familiar with them. Par exemple, vous pouvez utiliser la Group By liste déroulante, pour faciliter la recherche d’une règle spécifique, ou la catégorie de règles.For example, you can use the Group By drop-down list to help in locating a specific rule, or category of rules. Un autre exemple est que vous pouvez utiliser la masquer les règles désactivées bouton dans la barre d’outils des pages de jeu de règle pour masquer ou afficher toutes les règles avec la Action colonne définie sur aucun.Another example is that you can use the Hide Disabled Rules button in the rule set pages toolbar to hide or show all the rules with the Action column set to None. Cela peut être utile si vous souhaitez effectuer une analyse des règles que vous avez désactivé pour vérifier que vous souhaitez toujours les désactivé.This can be useful if you want to scan for any rules that you have turned off to verify that you still want to have them disabled.

  5. Dans le menu Affichage, cliquez sur Propriétés.On the View menu, click Properties Window. Type ensemble de règles personnalisé Mes dans la zone Nom de la fenêtre d’outil Propriétés.Type My Custom Rule Set in the Name box of the Properties tool window. Cela modifie le nom complet de la nouvelle règle définie dans le Visual StudioVisual Studio IDE.This changes the display name of the new rule set in the Visual StudioVisual Studio IDE.

  6. Sur le fichier menu, cliquez sur enregistrer toutes les règles Microsoft.ruleset enregistrer la règle personnalisée définie.On the File menu, click Save Microsoft All Rules.ruleset to save your customized rule set. Accédez au dossier racine de votre projet.Navigate to the root folder of your project. Dans le nom de fichier zone de texte, tapez MyCustomRuleSet.In the FileName text box, type MyCustomRuleSet. L’ensemble de règles personnalisé peut maintenant être sélectionné pour une utilisation avec votre projet.The custom rule set can now be selected for use with your project.

Désormais avec votre nouvel ensemble de règles créé, vous devez configurer les paramètres du projet pour spécifier que vous souhaitez utiliser votre nouvel ensemble de règles avec.With your new rule set created, now you have to configure your project settings to specify that you want to use your new rule set with it.

Spécifiez la nouvelle règle pour une utilisation avec votre projetSpecify the new rule set for use with your project

  1. Dans l’Explorateur de solutions, cliquez sur le projet, puis sélectionnez propriétés.In Solution Explorer, right-click the project and then select Properties.

  2. Dans le propriétés , cliquez sur l’analyse du Code.In the Properties tab, click Code Analysis.

    Dans le exécuter cet ensemble de règles la liste déroulante, cliquez sur <Parcourir... >.In the Run this rule set drop-down list, click <Browse..>. Accédez au dossier racine de votre projet de code, puis sélectionnez MyCustomRuleSet.ruleset.Navigate to the root folder of your code project and then select MyCustomRuleSet.ruleset. Il s’agit du nouvel ensemble de règles que vous avez créé dans la procédure précédente.This is the new rule set that you created in the previous procedure.

  3. Sur le fichier menu, cliquez sur enregistrer pour enregistrer la configuration de votre projet.On the File menu, click Save to save your project configuration. L’ensemble de règles personnalisé peut maintenant être utilisé avec votre projet.The custom rule set can now be used with your project.

    Enfin, vous allez exécuter l’analyse du Code en utilisant votre ensemble de règles MyCustomRuleSet.Finally, you will run Code Analysis again using your MyCustomRuleSet rule set. Notez que la fenêtre liste d’erreurs n’affiche pas la violation de règle de performance CA1704.Notice that the Error List window does not display the CA1704 performance rule violation.

Exécuter l’analyse du Code sur le projet RuleSetSample pour la deuxième foisRun Code Analysis on the RuleSetSample project for the second time

  1. Sur le analyser menu, cliquez sur exécuter l’analyse du Code sur RuleSetSample.On the Analyze menu, click Run Code Analysis on RuleSetSample.

  2. Dans la fenêtre liste d’erreurs, notez que lorsque vous cliquez sur avertissements, vous ne voyez plus l’avertissement CA1704 concernant la règle « Identificateurs doit être correcte ».In the Error List window, notice that when you click Warnings, you no longer see the CA1704 warning violations for the "Identifiers should be spelled correctly" rule.

Voir aussiSee also

Comment : configurer l’analyse du Code pour un projet de Code managé How to: Configure Code Analysis for a Managed Code Project
Informations de référence sur l’ensemble de règles d’analyse du codeCode analysis rule set reference