C# - Convenciones del Lenguaje

Las convenciones de lenguaje en C# son pautas establecidas para nombrar elementos en el código, como clases, métodos, variables, propiedades, entre otros. El seguimiento de estas convenciones ayuda a mantener un código consistente, facilita la lectura y comprensión del mismo, y mejora la colaboración en proyectos compartidos. A continuación, se presentan algunas convenciones de lenguaje comunes en C#:

c# conventions

  1. PascalCase para Nombres de Clases y Tipos:
    • Los nombres de clases, interfaces, enumeraciones y tipos deben usar PascalCase, donde cada palabra comienza con una letra mayúscula.
    • Ejemplo: MyClass, CarModel, ProductManager, QuestionTypeEnum > Checkbox
  2. CamelCase para Nombres de Variables y Parámetros:
    • Los nombres de variables locales, constantes, parámetros de métodos y campos privados deben usar camelCase, donde la primera palabra comienza con minúscula y las palabras subsiguientes comienzan con mayúsculas.
    • Ejemplo: myVariable, productName, itemCount
  3. PascalCase para Nombres de Métodos y Propiedades:
    • Los nombres de métodos y propiedades deben usar PascalCase, al igual que los nombres de clases y tipos.
    • Ejemplo: GetProductInfo(), TotalItemCount
  4. Prefijo de "_ underscore" para Campos Privados:
    • Los campos privados en una clase deben tener un prefijo de "_ underscore" seguido de camelCase.
    • Ejemplo: _privateField, _dataList
  5. Uso de Acrónimos:
    • Los acrónimos en los nombres deben escribirse usando PascalCase, independientemente de cómo se pronuncian.
    • Ejemplo: XmlParser, HtmlEncoder
  6. Evitar Nombres Genéricos Simples:
    • Los nombres genéricos, como T, deben evitarse a menos que sean muy obvios en su uso.
    • Preferible: TItem, TResult
  7. Sufijo de "Async" para Métodos Asincrónicos:
    • Los métodos asincrónicos deben terminar con el sufijo "Async".
    • Ejemplo: LoadDataAsync(), ProcessRequestAsync()
  8. Nombres Significativos:
    • Los nombres de variables, métodos y tipos deben ser significativos y reflejar claramente el propósito de la entidad que representan.
  9. Evitar Nombres con Prefijos o Sufijos Redundantes:
    • Evitar usar prefijos o sufijos que no agreguen significado real, como "My", "cls", "obj", entre otros.

Comentarios

Entradas populares