Es un placer saludar a mis lectores como cada semana.

En esta ocasión les traigo una entrada sobre las convenciones de nombres en Java

¿Qué son las convenciones de código?

Las convenciones de código son un conjunto de directrices para un lenguaje de programación específico que recomiendan estilo de programación, prácticas y métodos para cada aspecto de un programa escrito en ese lenguaje. [Wikipedia]

Las convenciones de código incluyen:

• Organización de archivos
• Uso de sangría
• Comentarios
• Declaraciones
• Sentencias
• Espacios en blanco
• Convenciones de nombre
• Prácticas de programación
• Principios de programación

Es importante mencionar que las convenciones de código (también llamadas convenciones de codificación) son una serie de guías que se consideran dentro de las buenas prácticas de programación, las cuáles están orientadas a lograr un software de calidad y que sea más fácil de mantener.

Las convenciones de código sólo aplican para los humanos, esto quiere decir que al compilador o intérprete del lenguaje en que estemos programando realmente no le interesan estas reglas, por lo que muchos programadores novicios pueden sentir que su maestr@ sólo la trae en su contra por hacerles observaciones en la forma en que se declaran variables o incluso el nombre que se les da a las clases. Si estás dentro de este grupo de estudiantes, piensa que en realidad las convenciones de código son útiles, son buenos hábitos que a la larga darán sus frutos.

Es como la escritura humana: a los niños pequeños que están aprendiendo a escribir se les piden planas y planas de trazos y letras con la finalidad de que su mano se acostumbre al uso del lápiz, pero también para que aprendan a hacer los trazos de la mejor forma posible. Si a esta temprana edad se genera un buen hábito, seguramente cuando el niño crezca, tendrá una escritura legible. Por lo tanto, te conviene si estás aprendiendo a programar, comenzar a tener buenos hábitos para que cuando desarrolles grandes aplicaciones, éstas tengan un cierto nivel de calidad.

¿Por qué usarlas?

Es muy recomendable que los programadores de software las utilicen porque:

• Mejoran la lectura del código fuente: sí, sé que por el momento estás pensando que sólo tú vas a leer tu código, y que, si el programa corre, y tú lo entiendes, entonces con eso debería bastar, pero en la realidad no es así. Generalmente un software profesional nunca es desarrollado por una sola persona, sino por un equipo de desarrollo, para los cuales les debe ser fácil leer el código que realices.
• Facilitar el mantenimiento del software: de nuevo, quizá hoy no sea necesario darle mantenimiento a ese programa que estás creando para calcular la serie de Fibonacci, pero en el futuro estarás desarrollando aplicaciones y sistemas de gran tamaño. Para las empresas que se dedican a la creación de software, el 80% del costo de desarrollo de un software cae en la etapa de mantenimiento. Y esto puede suceder por diversos factores, pero si te toca estar en el papel de alguien que le va a dar mantenimiento al software, rezarás porque el código se encuentre documentado y escrito con las convenciones de código.
• Un porqué que resalta Sun es la necesidad de crear productos “limpios”, viendo el código como un producto que será vendido, se busca que el código sea entendible y atractivo de leer.

Las convenciones de código de Java

En esta sección mencionaré algunas de las más importantes convenciones de código de Java.

Archivos

Las extensiones que usan los archivos de Java son:

Figura 1. Extensiones de archivos de java

Clases

El primer carácter del nombre de una clase debe ser una letra mayúscula. Si el nombre requiere varias palabras para ser entendible, se debe utilizar la notación UpperCamelCase o Camello Mayúsculas: el cual es un estilo de escritura que se aplica a frases compuestas por varias palabras, en el cual la primera letra de cada una de las palabras es mayúscula, algo así como esto: EjemploDeUnaClase. Se deben usar palabras completas – evitar acrónimos y abreviaturas (a menos que la abreviatura es mucho más extendido que el de la forma larga, como la dirección URL o HTML).

Además, se debe considerar que el nombre de una clase es un sustantivo (una palabra usada para identificar cualquier clase de personas, lugares o cosas) Un nombre apropiado para una clase pueden ser:

• Automovil
• Empleado
• EmpleadoFederal
• CuentaDeAhorros

Métodos

Los métodos expresan acciones que permiten modificar a los atributos de una clase, por lo que los nombres de los métodos deben ser verbos, y se deben escribir con la primera letra minúscula con la primera letra de cada palabra interna en mayúscula, usando LowerCamelCase,  de la siguiente forma.

• getSaldo
• generalBalance
• obtenerFechaMantto

En los estándares de la POO, existen dos tipos de métodos que por su propio nombre ya definen el tipo de acción a realizar: get y set.

• Un método get obtiene y regresa el valor de un atributo de la clase, de tal modo que cada atributo de la clase deberá tener un método get asociado: getId, getNombre, getSaldo, etc.
• Un método set establece el valor de un atributo de la clase, y al igual que el método get, debe existir un set por cada atributo en la clase. Algunos IDEs tienen facilidades para crear de forma automática los métodos get y set.

Variables

Las variables también son sujetos, pero a diferencia de las clases, estas deben ser escritas preferentemente en minúsculas. Se usará LowerCamelCase de ser necesario. Los nombres de variable no deben comenzar con los caracteres guión bajo ( _ ) o dólar ($), aunque no se consideran como caracteres especiales.

Se recomienda que los nombres de las variables sean cortos pero significativos. Además, que el nombre tenga relación con el problema. Se aconseja también que se evite el uso de variables con nombres de un solo carácter, a no ser que se traten de variables temporales, en cuyo caso los nombres más comunes son i, j, k, m y n para enteros, c, d y e para caracteres.

Constantes

Los nombres de las constantes deben ser declaradas en mayúsculas, usando el “_” (guión bajo) si el nombre de la constante es largo. Los nombres de las constantes pueden contener dígitos, pero nunca para iniciar el nombre. Ejemplos:

• PI
• PAGO_POR_HORA

Sangrías

Se considera un estándar de 4 espacios como unidad de identación, aunque si utilizas un IDE generalmente no tendrás que preocuparte porque automáticamente te ayudará colocando la sangría adecuada.

Organización del archivo de código

Las buenas prácticas de programación de Java establecen una organización de los elementos del programa que es la siguiente:

1. Comentarios iniciales
2. Sentencias de importación de paquetes
3. Declaraciones de clases y/o interfaces, y dentro de estas:
   1. Comentario para documentar la clase o interface
   2. La sentencia class o interface
   3. Comentario sobre la implementación de la clase/interface, en caso de que sea necesario
   4. Variables de clase:
      1. Públicas (public)
      2. Protegidas (protected)
      3. Privadas (private)

1. Variables de instancia, en el mismo orden que las variables de clase.
2. Constructores
3. Métodos

Netbeans y las convenciones de código.

Los IDEs ayudan mucho en la creación de un código limpio y documentado. En mayor o menor grado incluyen guías para escribir tu programa con las buenas prácticas de programación. En la figura 1 te muestro un pequeño programa con las ayudas de NetBeans :

Figura 2. Ejemplo de Uso de las Convenciones de Código usando NetBeans

Me despido de todos ustedes una vez más, esperando que esta información haya sido de utilidad. Si te gustó, dale  en “me gusta”, y comparte con quien pueda serle útil. También recuerda que si tienes dudas, escríbeme y trataré de resolverlas (o ampliarlas)