JavaScript | Guía de estilo y convenciones de codificación

Las pautas de estilo de JavaScript son instrucciones para regular la programación en javascript . Estas prescripciones de codificación son beneficiosas para escribir código en javascript sin errores sintácticos. Cubre la denominación de las variables, la dirección para poner espacios en blanco y punto y coma y varias pautas de declaración. 
También puede mejorar la calidad, la legibilidad y facilitar el mantenimiento del código.

Este artículo básicamente cubre convenciones de codificación como: 

  • Sangría
  • Espacios, todos los corchetes
  • Declaración de variables
  • Directrices de objetos
  • CamelCasing para nombres de identificadores
  • Bucles y sentencias de control
  • Pautas de declaración
  • Constructor
  • Comentarios

1. Sangría: 
Siempre sangramos nuestro código usando dos espacios y nuestro código no debe terminar con espacios en blanco al final. 

Javascript

function xyz{
  something();
}

2. Espacios, todos los corchetes: Los 
espacios en blanco siempre deben usarse en las siguientes circunstancias: 

  • Una palabra clave seguida de ‘(‘ o ‘)’ debe proporcionar espacios en blanco antes y después.
    si (condición) {
  • Todas las palabras clave como ‘función’, ‘tipo de’, etc. necesitan atención adicional para los espacios en blanco y un espacio proporcionado después. 

Javascript

let integer = function (
    value,
    default_value
) {
    value = resolve(value);
    return (10*value);
};

3. Declaración de variables: 
Todas las variables deben declararse con var antes de ser utilizadas. principalmente declaramos la variable al comienzo de la función. 
Todos los nombres comienzan con una letra. 

Javascript

NAME = "GFG";
Fullform = "GeeksforGeeks";
Rate = 19.90;
Hate = 0.20;
Ranking = Rate + (Rate / Hate);

4. Pautas de objetos: 
reglas generales para las definiciones de objetos: 
hay varios tipos de objetos en javascript como array, función, fechas, objetos definidos por el usuario. 
Básicamente, cada objeto sigue un estilo de codificación simple escrito a continuación. 
En Javascript, ponemos un paréntesis de apertura e igual (=) después de declarar el nombre del objeto. Definimos la propiedad usando dos puntos: y colocamos los valores de string entre comillas «xyz», pero no en el valor numérico. Ponemos un punto y coma al final de una propiedad y no lo ponemos al final de la última propiedad.

Javascript

var platform = {
  firstName: "GEEKS",
  lastName: "GEEKS",
  Color: "GREEN"
};
//some are compressed can be written as
var platform = {firstName:"GEEKS", lastName:"GEEKS", Color:"GREEN"};

5. Camel casing para nombres de identificadores: 
En su mayoría usamos camelcase para el identificador. En camel casing, la primera letra de cada función debe estar en minúscula y la primera letra de las palabras subsiguientes debe estar en mayúscula. Ejemplo 

Javascript

function myFunction(a, b) {
  return a * b;
}

No debe haber guiones bajos entre las palabras. 
Si usa una combinación de mayúsculas y minúsculas, debe ser extremadamente consistente y cuidadoso.

6. Bucles y estructuras de control:
usamos la misma convención de paréntesis y corchetes para las estructuras de control, como se explica a continuación. 

  • Siempre siga un espacio en blanco después de un identificador de instrucciones de control. 
  • Proporcione siempre espacios en blanco y saltos de línea después de ; punto y coma. 
  • Proporcione siempre un espacio en blanco después de cada coma. 

Javascript

if (condition1 || condition2) {
  action1();
}
else if (condition3 && condition4) {
  action2();
}
else {
  defaultAction();
}

7. Pautas de declaración: 

  • Declaración simple:
    La declaración que consta de una sola línea Siempre termina con un punto y coma.
  • Declaración compuesta:
    en javascript, colocamos el espacio y el corchete de apertura {y tenemos una lista de declaraciones con corchete de cierre} al final. 
    por ejemplo: al final de la declaración del nombre de la función antes de definirla. 
    Colocamos el corchete de cierre en una nueva línea sin seguir el rastro de espacios en blanco. 
    No ponemos el punto y coma al final de este tipo de declaraciones.
  • Declaraciones de varias líneas:
    en javascript Siempre que una declaración no sea lo suficientemente pequeña para caber en una línea, los 
    saltos de línea deben ocurrir después de un operador. 
    Para mejorar la legibilidad, las líneas deben dividirse en varias líneas.

Javascript

//simple statement 
var gfg = ["Geeks", "For", "Geeks"];
   
//compound statement
for (i = 0; i < 5; i++) {
  a += i;
}
//multiline statement
if (
  a === 123
  && b === 'abc'
) {

8. Constructor:
en javascript, los constructores se utilizan en forma de función con una nueva palabra clave. 
El nuevo prefijo crea un nuevo objeto y vincula ese objeto al parámetro this implícito de la función. 
Las funciones constructoras DEBEN recibir nombres con un carácter inicial en mayúscula. 

Javascript

function GeeksforGeeks(node) {}
 
var geeksforgeeks= new GeeksforGeeks(element);

9. Comentarios: 
use comentarios de línea, no comentarios de bloque. Los comentarios deben comenzar en el margen izquierdo. 
Utilice ‘//’ al comienzo de los comentarios. 

Javascript

// Set i to zero.
     
    i = 0;

Publicación traducida automáticamente

Artículo escrito por ashishsaini3 y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA

Deja una respuesta

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