Estándares de codificación 

Alguna vez te ha tocado analizar tu propio código después de algún tiempo que lo escribiste, es difícil recordar lo que hace, tratar de identificar si en la variable a guardé el valor de ventas o el valor de compras, ahora imagínate si es el código de otro compañero 😱

Para minimizar este tipo de situaciones se establecen los estándares de código que  son parte de las buenas prácticas en las comunidades de desarrolladores; podemos decir que son un conjunto no formal de reglas que bien aplicadas pueden incrementar la calidad de código de manera notable.

Este conjunto de reglas pueden ser denominaciones de variables, archivos, tabulaciones, formatos, etc.

Algunos ejemplos son:

• Para el nombre de clases se deben utilizar sustantivos
• Para el nombre de métodos se debe indicar la primera palabra con un verbo en infinitivo y de preferencia en ingles (ej  addPersona)
• Para la estructura de una clase el orden de los elementos principales deber ser:
• atributos
• constructor(es)
• métodos Get y Set
• Métodos propios de la clase
• Para la definición de variables nunca se debe utilizar abreviaturas, los nombres de las variables deben ser lomas descriptibles posible.
• Para las estructuras switch y for se debe indicar el final de la estructura con un comentario que contenga la estructura y el nombre de la variable que controla con la finalidad que en los casos en donde se tiene anidación de estructuras de control, se identifique fácilmente el bloque de código que controla. Ejemplo:
  •   for (int z= 0; z< 10; z++) { 2:      LOG.info("valor de z: 3"); 3:     } // for  

Cuando comenzamos a programas bajo este conjunto de reglas pudiera ser innecesario y tedioso, pero con el tiempo al retomar un programa nos damos cuenta de la utilidad que representa.

Por si es de tu interés conocer más de este tema te dejo los siguientes links:

http://www.net2client.net/manual/nuevomanual/Estandares_y_normas_de_programacion.htm

https://www.gestion.uco.es/gestion/aplicaciones/docs/NormasyEstandares.pdf

https://webirix.com/estandares-de-programacion-2/