Coding Style

Convenciones y recomendaciones oficiales de Angular Coding Style


Angular, al igual que muchos otros frameworks y lenguajes de programación, tiene una serie de convenciones y recomendaciones que ayudan a que el código sea más consistente, legible y mantenible. Esta misma se encuentra desarrollada en detalle aquí: Angular Coding Style.

Esta es una lista resumida con los puntos más importantes:

Single responsibility

El principio de responsabilidad única ayuda a crear una aplicación limpia, fácil de leer y mantener. Mas información en la Wikipedia.

  1. Limitar los archivos a 400 lineas de código.
  2. Definir funciones específicas y pequeñas, no más de 75 lineas de código

Guia general de nomenclatura

Mantener una convención estándar para la nomenclatura es muy importante para la mantención y, sobre todo, la legibilidad del código.

  1. Mantener un estándar al nombrar símbolos.
  2. Usar guiones para separar palabras dentro del nombre del componente.
  3. Usar puntos para separar el nombre del tipo o símbolo.
  4. El nombre de las propiedades y los métodos deben siempre ser camelCase.
  5. Utilizar prefijos personalizados (selectors) para prevenir que los nombres de los elementos entren en conflicto con otros componentes o elementos de HTML.
  6. Para los selectores debe utilizarse dashed-case e identificar a la “característica/funcionalidad” que pertenece el componente.
// Usar
    prefix-custom-button
// Evitar
    prefixCustomButton
  1. Las clases no deben terminar con “Impl” y si deben utilizar UpperCamelCase. 1
  2. Las interfaces no deberían comenzar con la primer letra “I” y deben utilizar UpperCamelCase. 1
  3. Declarar las variables const siempre que sea posible.

Footnotes

  1. Naming Angular doc 2