CA1704: La ortografía de los identificadores debe ser correcta

Elemento Valor
RuleId CA1704
Category Microsoft.Naming
Cambio importante Problemático

Causa

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

Descripción de la regla

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

  • Las letras mayúsculas inician un nuevo token. Por ejemplo, MINombreEsJose tokeniza en "Myi", "Nombre", "Es", "Jose".

  • Para varias letras mayúsculas, la última letra mayúscula inicia un nuevo token. Por ejemplo, GUIEditor tokeniza en "GUI", "Editor".

  • Se quitan apóstrofos iniciales y finales. Por ejemplo, 'sender' tokeniza en "sender".

  • Los guiones bajos indican el final de un token y se quitan. Por ejemplo, Hola_mundo tokeniza en "Hola", "mundo".

  • Se quitan las y comerciales insertadas. Por ejemplo, for&mato tokeniza en "formato".

Lenguaje

Actualmente, el corrector ortográfico solo comprueba los diccionarios de referencia cultural basados en inglés. Puede cambiar la referencia cultural del proyecto en el archivo del proyecto agregando el elemento CodeAnalysisCulture.

Por ejemplo:

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

Importante

Si establece la referencia cultural en algo distinto de una referencia cultural basada en inglés, esta regla de análisis de código se deshabilita silenciosamente.

Cómo corregir infracciones

Para corregir una infracción de esta regla, corrija la ortografía de la palabra o agregue la palabra a un diccionario personalizado.

Agregar palabras a un diccionario personalizado

Asigne al archivo XML de diccionario personalizado el nombre 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 en el perfil del usuario (%USERPROFILE%\Application Data\...). Para obtener información sobre cómo agregar el diccionario personalizado a un proyecto en Visual Studio, consulte Cómo: Personalizar el diccionario de análisis de código.

  • Agregue palabras que no deban causar una infracción en la ruta Dictionary/Words/Recognized.

  • Agregue palabras que deban causar una infracción en la ruta Dictionary/Words/Unrecognized.

  • Agregue palabras que se deban marcarse como obsoletas en la ruta Dictionary/Words/Deprecated. Consulte el tema de regla relacionada CA1726: Utilizar términos preferidos para obtener más información.

  • Agregue excepciones a las reglas de mayúsculas y minúsculas de acrónimos a la ruta 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 las advertencias

Suprima una advertencia de esta regla solo si la palabra está mal escrita intencionadamente y la palabra 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.

Consulte también