Los identificadores deberían tener la ortografía correcta

Artículo
10/07/2008

Actualización: noviembre 2007

Nombre de tipo	IdentifiersShouldBeSpelledCorrectly
Identificador de comprobación	CA1704
Categoría	Microsoft.Naming
Cambio problemático	Sí

Motivo

El nombre de un identificador visible externamente contiene una o varias palabras que la biblioteca de correctores ortográficos de Microsoft no reconoce. Esta regla no comprueba los constructores ni los miembros con nombres especiales como los descriptores de acceso de propiedad get y set.

Descripción de la regla

Esta regla analiza el identificador en tokens y comprueba la ortografía de cada uno. El algoritmo de análisis realiza las transformaciones siguientes:

Las letras mayúsculas inician un nuevo token. Por ejemplo, MiNombreEsJuan se convierte en los tokens "Mi", "Nombre", "Es", "Juan".
Si hay varias letras mayúsculas, la última inicia un nuevo token. Por ejemplo, GUIEditor se convierte en los tokens "GUI" y "Editor".
Se quitan los apóstrofos iniciales y finales. Por ejemplo, 'remitente' se convierte en el token "remitente".
Los caracteres de subrayado indican el final de un token y se quitan. Por ejemplo, Hola_a_todos se convierte en los tokens "Hola" "a" "todos".
Los símbolos incrustados de Y comercial se quitan. Por ejemplo, for&mato se convierte en el token "formato".

De forma predeterminada, se utiliza la versión inglesa (en) del corrector ortográfico.

Cómo corregir infracciones

Para corregir una infracción de esta regla, escriba la palabra correctamente o agréguela a un diccionario personalizado denominado CustomDictionary.xml. Coloque el diccionario en el directorio de instalación de la herramienta, en el directorio del proyecto o en el directorio asociado a la herramienta bajo el perfil del usuario (%USERPROFILE%\Datos de programa\...).

Agregue las palabras que no deben causar una infracción a la ruta de acceso Dictionary/Words/Recognized.
Agregue las palabras que deben causar una infracción a la ruta de acceso Dictionary/Words/Unrecognized.
Agregue las palabras que deben marcarse como obsoletas a la ruta de acceso Dictionary/Words/Deprecated. Vea el tema de regla relacionado "Utilizar términos preferidos" para obtener más información.
Agregue las excepciones a las reglas de grafía de los acrónimos a la ruta de acceso Dictionary/Acronyms/CasingExceptions.

A continuación, se muestra un ejemplo de la estructura de un archivo de diccionario personalizado.

   <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>

Cuándo suprimir advertencias

Suprima una advertencia de esta regla sólo si la palabra está escrita incorrectamente de manera intencionada y se aplica a un conjunto limitado de la biblioteca. Las palabras escritas correctamente reducen la curva de aprendizaje necesaria para las nuevas bibliotecas de software.