Tips para mejorar tu estilo de programacion (II)

Hola a todos.

Hoy os traigo la segunda parte de la serie «Tips para mejorar tu estilo de programación«, en la cual aprenderemos algunos consejos para mejorar nuestro código. Sino habéis leído el primero aquí os lo dejo Tips para mejorar tu estilo de programacion (I).

Os recuerdo que en el post anterior veíamos la importancia de usar nombres y clases descriptivos/representativos, además de tener una uniformidad en el idioma en todo nuestro proyecto.

Siguiendo en la misma línea, veamos el siguiente fragmento de código:

Como podemos ver los nombres de las variables son sustantivos que representan una entidad y los métodos representan una acción por lo que suelen contener un verbo.

En nuestro caso tenemos el método GetName que devuelve el nombre de la clase Persona y el método IsOnline que devuelve un booleano en función del contenido de la variable online. En ambos casos hemos utilizado una notación CamelCase , es decir, la primera letra de cada palabra la está en mayúsculas y el resto en minúsculas.

La notación CamelCase es la más utilizada en los equipos de programadores al ser más intuitiva que el resto de notaciones .Aunque también existe la notación Húngara en la cual se agrega al principio de la variable el tipo al cual pertenece.

Si utilizamos nombres descriptivos y representativos conseguiremos evitar escribir más comentarios de los debidos. Es decir, si tenemos un código de 30 líneas y tenemos  15 de comentarios, deberíamos revisar el código y reescribir las variables y métodos para conseguir eliminar comentarios; con el fin de tener un código más comprensivo y útil.

En la segunda parte de este artículo sobre tips para mejorar tu estilo de programación vamos con los comentarios.

El primer objetivo de los comentarios es que tienen que ser útiles, es decir, no debemos comentar cosas obvias, así que, reflexiona antes de comentar si es necesario o no.

Ejemplo:

Además, debemos evitar agregar comentarios dentro de métodos y funciones, puesto que tenemos que comentar qué hace el método y no el cómo lo hace. Con una breve definición de lo que hace, cuales son los parámetros de entrada (si tiene) y cuál es el valor que retorna (si tiene) es más que suficiente.

Veamos un ejemplo en Java.

Analicemos este fragmento de código. Podemos ver que hemos agregado las etiquetas @param (indica los parámetros de entrada) y @return (indica los parámetros de salida), es la forma en la cual se debe comentar un método o clase en Java.

Si seguimos esta estructura de comentario conseguiremos un estilo limpio, claro y comprensivo. Además, al utilizar las etiquetas de @param y @return (*) podemos generar una pequeña API de forma automática para nuestro proyecto gracias al comando javadoc <nombrearchivo>.java .

Finalmente, añadir que los comentarios también deben de mantenerse, ser claros, precisos y con un lenguaje educado (recuerda que trabajas en equipo y debes ser respetuoso con tus compañeros). Comenta el código conforme lo estás escribiendo y no lo dejes para el final.

Espero que os haya gustado y que de esta forma poco a poco vayamos teniendo un código más limpio y comprensivo.

En la próxima entrega veremos la parte de espacios, tabulaciones y líneas en blanco.

(*) Nota: Más información sobre los comentarios en Java (Enlace).

Un saludo,

Daniel (@DaniLabs)