Postupy: Přizpůsobení slovníku Analýzy kódu

Nástroj Analýza kódu kontroluje v identifikátorech kódu pravopisné chyby, gramatiku a další zásady vytváření názvů podle pokynů rozhraní .NET Framework pomocí integrovaného slovníku.Lze vytvořit soubor Xml vlastního slovníku pro přidání, odebrání nebo úpravu výrazů, zkratek a zkratkových slov do integrovaného slovníku.

Předpokládejme například, že kód obsahuje třídu pojmenovanou DoorKnokker.Nástroj Kód analýzy by název identifikoval jako složeninu dvou slov: door a knokker.Pak by vyvolal upozornění, že knokker nebyl zadán správně.Pro přinucení analýzy kódu, aby pravopis rozpoznala, lze do vlastního slovníku přidat výraz knokker.

Pro vytvoření vlastního slovníku

Vytvořte soubor s názvem CustomDictionary.xml.

Definujte vlastní slova pomocí následující struktury XML:

<Dictionary>
      <Words>
         <Unrecognized>
            <Word>knokker</Word>
         </Unrecognized>
         <Recognized>
            <Word></Word>
         </Recognized>
         <Deprecated>
            <Term PreferredAlternate=""></Term>
         </Deprecated>
         <Compound>
            <Term CompoundAlternate=""></Term>
         </Compound>
         <DiscreteExceptions>
            <Term></Term>
         </DiscreteExceptions>
      </Words>
      <Acronyms>
         <CasingExceptions>
            <Acronym></Acronym>
         </CasingExceptions>
      </Acronyms>
   </Dictionary>

Prvky vlastního slovníku

Chování slovníku nástroje Analýza kódu lze upravit přidáním výrazů jako vnitřního textu následujících prvků ve vlastním slovníku:

• Dictionary/Words/Recognized/Word

• Dictionary/Words/Unrecognized/Word

• Dictionary/Words/Deprecated/Term[@PreferredAlternate]

• Dictionary/Words/Compound/Term[@CompoundAlternate]

• Dictionary/Words/DiscreteExceptions/Term

• Dictionary/Acronyms/CasingExceptions/Acronym

Dictionary/Words/Recognized/Word

Pro zahrnutí výrazu na seznam výrazů, které analýza kódu identifikuje jako správně napsané, přidejte výraz jako vnitřní text prvku Dictionary/Words/Recognized/Word.Výrazy v prvcích Dictionary/Words/Recognized/Word nerozlišují velká a malá písmena.

Příklad

<Dictionary>
      <Words>
         <Recognized>
            <Word>knokker</Word>
            ...
         </Recognized>
         ...
      </Words>
      ...
</Dictionary>

Výrazy v uzlech Dictionary/Words/Recognized podléhají následujícím pravidlům pro analýzu kódu:

• CA1701: Malá a velká písmena složených slov prostředku řetězců by měla být použita správně

• CA1702: Malá a velká písmena složených slov by měla být použita správně

• CA1703: Řetězce prostředků by měly být zadány správně

• CA1704: Identifikátory by měly být zadány správně

• CA1709: Malá a velká písmena identifikátorů by měla být použita správně

• CA1726: Použijte upřednostňované výrazy

• CA2204: Literály by měly být zadány správně

Dictionary/Words/Unrecognized/Word

Pro vyloučení výrazu ze seznamu výrazů, které analýza kódu identifikuje jako správně napsané, přidejte výraz, který chcete vyloučit, jako vnitřní text prvku Dictionary/Words/Unrecognized/Word.Výrazy v prvcích Dictionary/Words/Unrecognized/Word nerozlišují malá a velká písmena.

Příklad

<Dictionary>
      <Words>
         <Unrecognized>
            <Word>meth</Word>
            ...
         </Unrecognized>
         ...
      </Words>
      ...
</Dictionary>

Výrazy v uzlu Dictionary/Words/Unrecognized podléhají následujícím pravidlům pro analýzu kódu:

• CA1701: Malá a velká písmena složených slov prostředku řetězců by měla být použita správně

• CA1702: Malá a velká písmena složených slov by měla být použita správně

• CA1703: Řetězce prostředků by měly být zadány správně

• CA1704: Identifikátory by měly být zadány správně

• CA1709: Malá a velká písmena identifikátorů by měla být použita správně

• CA1726: Použijte upřednostňované výrazy

• CA2204: Literály by měly být zadány správně

Dictionary/Words/Deprecated/Term[@PreferredAlternate]

Pro zahrnutí výrazu do seznam výrazů, které analýza kódu identifikuje jako nepoužívaný, přidejte výraz jako vnitřní text prvku Dictionary/Words/Deprecated/Term.Nepoužívaný výraz je slovo napsáno správně, které by ale nemělo být používáno.

Pro zahrnutí navrženého alternativního výrazu do varování je nutné v atributu PreferredAlternate prvku výrazů určit jeho alternativu.Nechcete-li navrhnout alternativu, lze hodnotu atributu ponechat prázdnou.

• Nepoužívaný výraz v prvku Dictionary/Words/ Deprecated/Term nerozlišuje velká a malá písmena.

• Hodnota atributu PreferredAlternate rozlišuje malá a velká písmena.Pro složené alternativy použijte případ Pascalu.

Příklad

<Dictionary>
      <Words>
         <Deprecated>
            <Term PreferredAlternate="LogOn">login</Term>
            ...
         </Deprecated>
         ...
      </Words>
      ...
</Dictionary>

Výrazy v uzlu Dictionary/Words/Deprecated podléhají následujícím pravidlům pro analýzu kódu:

• CA1701: Malá a velká písmena složených slov prostředku řetězců by měla být použita správně

• CA1702: Malá a velká písmena složených slov by měla být použita správně

• CA1703: Řetězce prostředků by měly být zadány správně

• CA1704: Identifikátory by měly být zadány správně

• CA1726: Použijte upřednostňované výrazy

Dictionary/Words/Compound/Term[@CompoundAlternate]

Vestavěný slovník identifikuje některé výrazy spíše jako jednotlivé diskrétní výrazy, než složený výraz.Pro zahrnutí výrazu do seznamu výrazů, které analýza kódu identifikuje jako složené slovo, a pro specifikaci správné velikosti písmen výrazu, přidejte výraz jako vnitřní text prvku Dictionary/Words/Compound/Term.V atributu CompoundAlternate Prvku výrazu určete jednotlivá slova, která tvoří složený výraz, psaním prvního písmene jednotlivých slov jako velkého (případ Pascalu).Všimněte si, že výraz určený ve vnitřním textu je automaticky přidán do seznamu Dictionary/Words/DiscreteExceptions.

• Nepoužívaný výraz v prvku Dictionary/Words/ Deprecated/Term nerozlišuje velká a malá písmena.

• Hodnota atributu PreferredAlternate rozlišuje malá a velká písmena.Pro složené alternativy použijte případ Pascalu.

Příklad

<Dictionary>
      <Words>
         <Compound>
            <Term CompoundAlternate="CheckBox">checkbox</Term>
            ...
         </Compound>
         ...
      </Words>
      ...
</Dictionary>

Výrazy v uzlu Dictionary/Words/Compound podléhají následujícím pravidlům pro analýzu kódu:

• CA1701: Malá a velká písmena složených slov prostředku řetězců by měla být použita správně

• CA1702: Malá a velká písmena složených slov by měla být použita správně

• CA1703: Řetězce prostředků by měly být zadány správně

• CA1704: Identifikátory by měly být zadány správně

Dictionary/Words/DiscreteExceptions/Term

Pro vyloučení výrazu v seznamu výrazů, který analýza kódu identifikuje jako jednotlivé, diskrétní slovo, když je výraz kontrolován pravidly pro používání velkých a malých písmen pro složená slova, přidejte výraz jako vnitřní text prvku Dictionary/Words/DiscreteExceptions/Term.Výraz v prvku Dictionary/Words/DiscreteExceptions/Term nerozlišuje velká a malá písmena.

Příklad

<Dictionary>
      <Words>
         <DiscreteExceptions>
            <Term>checkbox</Term>
            ...
         </DiscreteExceptions>
         ...
      </Words>
      ...
</Dictionary>

Výrazy v uzlu Dictionary/Words/DiscreteExceptions podléhají následujícím pravidlům pro analýzu kódu:

• CA1701: Malá a velká písmena složených slov prostředku řetězců by měla být použita správně

• CA1702: Malá a velká písmena složených slov by měla být použita správně

Dictionary/Acronyms/CasingExceptions/Acronym

Pro zahrnutí zkratkového slova do seznamu výrazů, které analýza kódu identifikuje jako správně napsané, a pro indikaci jak zkratkové slovo při kontrole výrazu pravidly pro používání velkých a malých písmen, přidejte výraz jako vnitřní text prvku Dictionary/Acronyms/CasingExceptions/Acronym.Zkratkové slovo v prvku Dictionary/Acronyms/CasingExceptions/Acronym rozlišuje malá a velká písmena.

Příklad

<Dictionary>
      <Acronyms>
         <CasingExceptions>
            <Acronym>NESW</Acronym>   <!-- North East South West -->
            ...
         </CasingExceptions>
         ...
      </Acronyms>
      ...
</Dictionary>

Výrazy v uzlu Dictionary/Acronyms/CasingExceptions podléhají následujícím pravidlům pro analýzu kódu:

• CA1709: Identifiers should be cased correctly

Pro použití vlastního slovníku pro projekt

1. V Průzkumníku řešení použijte jeden z následujících postupů:

2. Pro přidání slovníku k jedinému projektu klikněte pravým tlačítkem myši na název projektu a pak na tlačítko Přidat existující položku.Zadejte soubor v dialogovém okně Přidat existující položku.

3. Pro přidání slovníku, který je sdílen mezi dvěma nebo více projekty, vyhledejte soubor pro sdílení v dialogovém okně Přidat existující položku, klikněte na šipku dolů na tlačítku Přidat a potom klikněte na tlačítko Přidat jako odkaz.

4. V Průzkumníku řešení klikněte pravým tlačítkem myši na název souboru CustomDictionary.xml a klikněte na Vlastnosti.

5. Ze seznamu Vytvořit akci vyberte CodeAnalysisDictionary.

6. Ze seznamu Kopírovat do výstupního adresáře vyberte Nekopírovat.