El estilo a la hora de escribir nuestro código no afecta su funcionamiento, pero si a la compresión del mismo para otros desarrolladores. Por ello es importante seguir una serie de guías o consejos a la hora de escribirlo.
Hoy mostraremos algunas de las convenciones más comunes.
Finalización de instrucciones Aunque JavaScript permite finalizar las instrucciones sin utilizar punto y coma, debemos finalizarlas con él.
// Mal
var foo = "foo"
// Bien
var foo = "foo";
JavaScript posee un mecanismo ASI (Automatic Semicolon Insertion) que le permite insertar punto y coma en aquellas zonas donde detecta que es necesario. En la mayoría de casos averigua correctamente donde debe insertarlos, pero no siempre. Mostramos un ejemplo de ello.
function getMovie()
{
return
{
titulo: "El lado bueno de las cosas",
titulo: "Argo"
}
}
Cuando está función es procesada, obtenemos lo siguiente:
function getMovie()
{
return;
{
titulo: "El lado bueno de las cosas",
titulo: "Argo"
};
}
A pesar de que nuestra función estaba pensada para devolver una estructura de datos, con un conjunto de películas, devolverá undefined. Este ejemplo sería procesado correctamente, si pusiéramos la llave inicial en la misma línea que el return:
return {
titulo: "El lado bueno de las cosas",
titulo: "Argo"
};
Líneas en blanco
Las líneas en blanco en nuestro código nos permiten separar líneas de código no relacionadas. Debemos tratar de utilizar una línea en blanco en los siguientes casos:
* Entre métodos.
* Entre variables locales y la primera línea de un método.
* Antes de un comentario.
* Entre distintas secciones dentro de un método para mejorar su comprensión.
Longitud de máxima de la línea
Debemos tratar de no superar los 80 caracteres por líneas, si excedemos esta cantidad debemos romper la línea.
Comentarios
Debemos introducir comentarios que ayuden a entender el código siempre que podamos. No debemos caer en el error de comentar cosas obvias:
// Inicializamos la variable i a cero.
var i = 0;
Los comentarios, tanto los de una sola línea como los multilínea, deben ir precedidos de una línea en blanco.
En el caso de los comentarios individuales, pueden incluirse en la línea que precede al código, o en la misma línea, en este último caso normalmente se tabula el mismo.
Nombrado de variables
Las variables suelen ser nombradas siempre en camel case. Suelen comenzar con un sustantivo, que las diferencia de las funciones o métodos, que deben comenzar con un verbo. Ejemplos:
// Correcto
var contador = 2;
var ultimaPeliculas = "Titanic";
// Incorrecto
var getContador = 23;
var isUltimaPelicula = "Argo";
Debemos utilizar nombres cortos, que indiquen el tipo de los valores que almacenan. Debemos evitar el uso de nombres que carezcan de significado como temp, foo, bar...
Nombrado de funciones
Las funciones también se nombran usando camel case, y deben comenzar por un verbo. Existen un conjunto de verbos utilizados en la mayoría de casos: get, set, is, has...
La utilización de los verbos, hace que el código sea más legible.
Existen muchas más reglas que seguir para que nuestro código sea lo más limpio y fácil de entender posible. Alguno de los organismos y empresas que definen reglas para ello son: Google, Crockford, Dojo...
Esperamos que este artículo os ayude a mejorar vuestro código JavaScript.