CA1704: Gli identificatori devono essere digitati correttamente

  • Articolo
Articolo Valore
ID regola CA1704
Category Microsoft.Naming
Modifica Interruzione

Causa

Il nome di un identificatore contiene una o più parole non riconosciute dalla libreria del correttore ortografico Microsoft. Questa regola non controlla i costruttori o i membri con nome speciale, ad esempio le funzioni di accesso alle proprietà get e set.

Descrizione regola

Questa regola analizza l'identificatore in token e controlla l'ortografia di ogni token. L'algoritmo di analisi esegue le trasformazioni seguenti:

  • Le lettere maiuscole iniziano un nuovo token. Ad esempio, MyNameIsJoe tokenzza in "My", "Name", "Is", "Joe".

  • Per più lettere maiuscole, l'ultima lettera maiuscola avvia un nuovo token. Ad esempio, GUIEditor tokenzza in "GUI", "Editor".

  • Gli apostrofi iniziali e finali vengono rimossi. Ad esempio, 'sender' tokenizes to "sender".

  • I caratteri di sottolineatura indicano la fine di un token e vengono rimossi. Ad esempio, Hello_world tokenzza in "Hello", "world".

  • Le e commerciale incorporate vengono rimosse. Ad esempio, for&mat tokenzza in "formato".

Lingua

Il correttore ortografico controlla attualmente solo i dizionari delle impostazioni cultura basate sull'inglese. È possibile modificare le impostazioni cultura del progetto nel file di progetto aggiungendo l'elemento CodeAnalysisCulture .

Ad esempio:

<Project ...>
  <PropertyGroup>
    <CodeAnalysisCulture>en-AU</CodeAnalysisCulture>

Importante

Se si impostano impostazioni cultura diverse dalle impostazioni cultura basate sull'inglese, questa regola di analisi del codice viene disabilitata automaticamente.

Come correggere le violazioni

Per correggere una violazione di questa regola, correggere l'ortografia della parola o aggiungere la parola a un dizionario personalizzato.

Per aggiungere parole a un dizionario personalizzato

Denominare il file XML del dizionario personalizzato CustomDictionary.xml. Posizionare il dizionario nella directory di installazione dello strumento, nella directory del progetto o nella directory associata allo strumento sotto il profilo dell'utente (%U edizione Standard RPROFILE%\Application Data\...). Per informazioni su come aggiungere il dizionario personalizzato a un progetto in Visual Studio, vedere Procedura: Personalizzare il dizionario di analisi del codice.

  • Aggiungere parole che non devono causare una violazione nel percorso Dizionario/Parole/Riconosciute.

  • Aggiungere parole che devono causare una violazione nel percorso Dizionario/Parole/Non riconosciuto.

  • Aggiungere parole che devono essere contrassegnate come obsolete nel percorso Dizionario/Parole/Deprecate. Per altre informazioni, vedere l'argomento relativo alla regola CA1726: Usare i termini preferiti.

  • Aggiungere eccezioni alle regole di combinazione di maiuscole e minuscole acronimi nel percorso Dictionary/Acronimi/CasingExceptions.

Di seguito è riportato un esempio della struttura di un file di dizionario personalizzato:

<Dictionary>
   <Words>
      <Unrecognized>
         <Word>cb</Word>
      </Unrecognized>
      <Recognized>
         <Word>stylesheet</Word>
         <Word>GotDotNet</Word>
      </Recognized>
      <Deprecated>
         <Term PreferredAlternate="EnterpriseServices">ComPlus</Term>
      </Deprecated>
   </Words>
   <Acronyms>
      <CasingExceptions>
         <Acronym>CJK</Acronym>
         <Acronym>Pi</Acronym>
      </CasingExceptions>
   </Acronyms>
</Dictionary>

Quando eliminare gli avvisi

Eliminare un avviso da questa regola solo se la parola è intenzionalmente digitata in modo non digitato e la parola si applica a un set limitato di librerie. Le parole digitate correttamente riducono la curva di apprendimento necessaria per le nuove librerie software.

Vedi anche