Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 2.39 KB

style-guide.md

File metadata and controls

31 lines (24 loc) · 2.39 KB

Estilo de código y buenas prácticas

Introducción

El estilo de código es una parte fundamental de la programación, ya que afecta la legibilidad, mantenibilidad y eficiencia del código. Un estilo de código consistente y bien estructurado facilita la colaboración entre desarrolladores, reduce la posibilidad de errores y mejora la calidad del software.

En este documento, se presentan algunas pautas y buenas prácticas para el estilo de código en Java, con enfoque en el desarrollo de aplicaciones empresariales y sistemas de información.

Convenciones de nomenclatura

Las convenciones de nomenclatura son reglas que dictan cómo nombrar variables, métodos, clases y otros elementos en un programa. Seguir convenciones de nomenclatura coherentes ayuda a que el código sea más legible y comprensible para otros desarrolladores.

Variables y atributos

  • Utiliza nombres descriptivos y significativos para las variables y atributos.
  • Usa camelCase para nombrar variables y atributos (ej. fullName, createdAt, creditCardNumber).
  • Evita nombres genéricos o abreviaturas que puedan ser confusos (ej. data, obj, tmp).
  • No uses caracteres especiales o símbolos en los nombres de variables (excepto _ para separar palabras en nombres largos).
  • Evita nombres demasiado largos que dificulten la lectura del código.
  • Usa nombres en inglés para mantener la coherencia en el código.
  • No uses prefijos o sufijos redundantes en los nombres de variables (ej. strName, intYear).
  • Evita nombres que puedan entrar en conflicto con palabras clave del lenguaje de programación.
  • Se recomienda utilizar nombres plurales para colecciones o listas y para el nombre de las tablas en bases de datos (ej. users, jobs).
  • Usa nombres que reflejen el propósito o contenido de la variable (ej. phoneNumber, firstName, lastName).
  • Evita nombres ambiguos o confusos que puedan llevar a malentendidos.
  • No uses nombres de variables que sean demasiado similares a otros existentes en el mismo ámbito.
  • Utiliza nombres que sean fáciles de pronunciar y recordar.
  • Evita nombres que sean demasiado genéricos o vagos (ej. dataJson, value).
  • No uses nombres de variables que sean demasiado específicos o técnicos (a menos que sea necesario).
  • Usa nombres que sean consistentes con el contexto y la funcionalidad de la variable.
  • Evita nombres que sean ofensivos, inapropiados o poco profesionales.