Convenciones de nombres en JavaScript

Convenciones de nombres en JavaScript


Convenciones de nombres en JavaScript

Si queremos escribir un código JavaScript de calidad, con unas características y estructura claras,  debemos acostumbrarnos a seguir una serie de reglas o convenciones.

Archivos

Por norma general, el código JavaScript debe ser almacenado en su correspondiente fichero de extensión js. No se debe enbeber dentro del código Html a menos que sea un proyecto muy pequeño ya que aumenta considerablemente el peso de la página. Si queremos minimizar el efecto demora, la llamada al fichero js (<script src=”fichero.js”>, se debe poner lo más abajo posible en el body.

Sangrías y tabulaciones

Debemos usar sangrías para facilitar la lectura del código. Aunque aumenta el tamaño de los ficheros, estos espacios son ignorados y no provocan retrasos en la ejecución.

Longitud de las líneas

Las líneas no deberían sobrepasar los 80 caracteres. Si hay que seguir la instrucción en la siguiente línea debemos dejar en ésta una sangría de 8 espacios.

Comenta tu código

Comentarios útiles y claros teniendo en cuenta que serán leídos posteriormente por nosotros mismos o por otras personas. En general, los comentarios en línea son más claros.

Declarar las variables

En JavaScript no es estrictamente necesario declarar las variables antes de usarlas, pero es una buena práctica ya que nos ayudará a evitar errores de variables no declaradas o variables globales mal utilizadas.

Declaración correcta de las funciones

No se deben dejar espacios entre el nombre de la función y el primer paréntesis, pero sí después del segundo y antes de la llave. Las instrucciones dentro de la función deben estar tabuladas cuatro espacios y la llave final en línea con la declaración de la función. Estro ayuda a comprender mejor estructuras complejas.

function imprimir(valor) {
    alert("valor");
}

Si se trata de una función anónima, entonces sí se debe dejar el espacio entre el nombre y el primer paréntesis. Si lo hacemos siempre así será mucho más fácil distinguir entre distintos tipos de funciones.

Convenciones de nombres

  • Los nombres deben estar formados por letras (a .. z, A .. Z) y dígitos (0 .. 9) y guión bajo _. Evitar el uso de caracteres especiales (<*^¨=?) o internacionales ($£àêß).
  • Las variables deben comenzar con una letra minúscula y las variables globales con mayúscula.
  • Se deben evitar nombres de una sola letra. Debemos usar nombres descriptivos que ayuden a entender el código. Nunca debemos usar nombres que se puedan confundir con palabras reservadas del lenguaje como break, const, else, new, entre otras.
var e = 29; //Mal
var edad = 29; //Bien
  • Usar camelCase para los nombres de objetos, funciones e instancias
var nuevoobjeto = {...} //Mal
var nuevoObjeto = {...} //Bien
function imprimirdatos(){...} //Mal
function imprimirDatos(){...} //Bien
var nuevousuario = new Usuario(); //Mal
var nuevoUsuario = new Usuario(); //Bien
  • Usar PascalCase (similar a camelCase pero la primera letra en mayúscula) para los nombres de clases y constructores
function moneda(valor){ //Mal
  this.cantidad = valor;
}
function Moneda(valor){ //Bien
 this.cantidad = valor;
}
var nuevaMoneda = new moneda(valor); //Mal
var nuevaMoneda = new Moneda(valor); //Bien
  • Usar guión  bajo delante de variables o propiedades privadas
this.saldo = 2000; //Mal
this._saldo = 2000; //Bien

Si te ha gustado no olvides compartir en redes sociales.

Espero que te haya servido. Cualquier duda deja un comentario. Un saludo

Dejar un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.

Translate »
Ir a la barra de herramientas