Si volem escriure un codi JavaScript de qualitat, amb unes característiques i estructura clares, hem acostumar-nos a seguir una sèrie de regles o convencions.
Arxius
Per norma general, el codi JavaScript ha de ser emmagatzemat en el seu corresponent fitxer d’extensió js. No s’ha de enbeber dins el codi Html a menys que sigui un projecte molt petit ja que augmenta considerablement el pes de la pàgina. Si volem minimitzar l’efecte demora, la crida a el fitxer js (< script src = “fichero.js” >, s’ha de posar el més baix possible en el body.
sagnats i tabulacions
Hem de fer servir sagnies per facilitar la lectura de el codi. Encara que augmenta la grandària dels fitxers, aquests espais són ignorats i no provoquen retards en l’execució.
Longitud de les línies
les línies no haurien de sobrepassar els 80 caràcters. Si cal seguir la instrucció en la següent línia hem de deixar en aquesta una sagnia de 8 espais .
Comenta el teu codi
comentaris útils i clars tenint en compte que seran llegits posteriorment per nosaltres mateixos o per altres persones. en general, els comentaris en línia són més clars.
declarar les variables
En JavaScript no és estrictament necessari declarar les variables abans d’usar-les, però és una bona pràctica ja que ens ajudarà a evitar errors de variables no declarades o variables globals mal utilitzades.
Declaració correcta de les funcions
No s’han de deixar espais entre el nom de la funció i el primer parèntesi, però sí després del segon i abans de la clau. Les instruccions dins de la funció han d’estar tabulades quatre espais i la clau final en línia amb la declaració de la funció. Estro ajuda a comprendre millor estructures complexes.
function imprimir(valor) { alert("valor");}
Si es tracta d’una funció anònima, llavors sí s’ha de deixar l’espai entre el nom i el primer parèntesi. Si ho fem sempre així serà molt més fàcil distingir entre diferents tipus de funcions.
Convencions de noms
- Els noms han d’estar formats per lletres (a .. z, A .. Z) i dígits (0 .. 9) i guió baix _. Evitar l’ús de caràcters especials (< * ^ ¨ =?) O internacionals ($ £ AESS).
- Les variables han de començar amb una lletra minúscula i les variables globals amb majúscula.
- s’han d’evitar noms d’una sola lletra. Hem de fer servir noms descriptius que ajuden a entendre el codi. Mai hem d’usar noms que es puguin confondre amb paraules reservades de l’llenguatge com break, const, else, new, entre d’altres.
var e = 29; //Malvar edad = 29; //Bien
- Utilitza CamelCase per als noms d’objectes, funcions i instàncies
var nuevoobjeto = {...} //Malvar nuevoObjeto = {...} //Bienfunction imprimirdatos(){...} //Malfunction imprimirDatos(){...} //Bienvar nuevousuario = new Usuario(); //Malvar nuevoUsuario = new Usuario(); //Bien
- Utilitza PascalCase (similar a CamelCase però la primera lletra en majúscula ) per als noms de classes i constructors
function moneda(valor){ //Mal this.cantidad = valor;}function Moneda(valor){ //Bien this.cantidad = valor;}var nuevaMoneda = new moneda(valor); //Malvar nuevaMoneda = new Moneda(valor); //Bien
- Utilitza guió baix davant de variables o propietats privades
this.saldo = 2000; //Malthis._saldo = 2000; //Bien
Si t’ha agradat no oblidis compartir en xarxes socials.