Cómo escribir comentarios en el código JavaScript

Los comentarios son notas que un programador deja en su código para que sea más comprensible. La mayoría de los desarrolladores senior se centran en el código de escritura que es eficiente y puede ser fácilmente leído e interpretado por las computadoras. Sin embargo, es de igual importancia hacer que el código sea fácilmente legible para las personas (que también trabajarán con el código en el futuro). Un programador debe saber cómo estructurar correctamente el código para que sea más comprensible para los humanos.

¿Qué son los comentarios??

Los comentarios pueden ser cualquier cosa, desde una explicación de una sola línea hasta una descripción de múltiples líneas del código que se escribe dentro del código fuente de un programa. Por lo general, se usan para dejar notas en las partes complejas del código fuente para que cualquiera que mire el código en el futuro pueda comprender fácilmente el propósito de ese código. Esta práctica ahorra tiempo, ya que cualquiera puede comprender fácilmente el propósito del código sin hacer ningún esfuerzo.

Ahora comencemos a aprender cómo estructurar adecuadamente el código fuente de JavaScript escribiendo diferentes tipos de comentarios:

Tipos de comentarios en JavaScript

JavaScript tiene dos tipos principales de comentarios:

• Comentarios de una sola línea.
• Comentarios de múltiples líneas

Comentarios de una sola línea: En JavaScript, se utilizan dos barras de avance (//) para escribir comentarios de una sola línea:

// Un comentario de una sola línea

Los comentarios en cualquier lenguaje de programación no tienen ningún efecto en el programa real. Los intérpretes/compiladores de los lenguajes de programación están diseñados de una manera que ignoran todos los comentarios al interpretar/compilar un programa.

Los comentarios pueden tener sus propias líneas separadas; También se pueden agregar en línea con otro código.

Comentarios en línea: Cuando se usan comentarios de una sola línea en la misma línea que el código, se denominan comentarios en línea:

dejar a = 30; // Un comentario en línea
Sea B = A + 10; // Agregar 10 en la variable "A" y asignarla a "B"

Los comentarios en línea se utilizan para explicar la línea exacta de código en la que están escritas; Se pueden usar para una descripción específica y pequeña del código presente en esa línea.

Comentarios de múltiples líneas: En JavaScript, los comentarios de bloque, los comentarios de varias líneas están escritos de la misma manera que están escritas en CSS con etiquetas de apertura (/*) y etiquetas de cierre (*/):

/* Un bloque
Comentario*/

Los intérpretes ignoran todo el texto entre las etiquetas de apertura y cierre.

Los comentarios de varias líneas o los comentarios de nivel de bloque se utilizan para explicar y dar una descripción detallada de una sección de código. Este tipo de comentarios generalmente se colocan en la parte superior del archivo del código fuente o antes de un bloque de código particularmente complejo:

/* Obtener el nombre del usuario
Desde un campo de entrada
y mostrarlo en la consola */
función showUser ()
name const = documento.getElementById ('Nombre de usuario');
consola.Log ("Hola y bienvenido al Linuxhint.com, " + nombre +".");

showuser ();

Comentar el código para probar/depurar: Los comentarios se pueden utilizar para evitar la ejecución de un código de bloque; Tantos desarrolladores de JavaScript senior también usan comentarios para fines de prueba y depuración. La colocación de las etiquetas de comentarios detrás de un bloque de código, por lo que el intérprete lo ignora y no se ejecuta se conoce como "Código de comentarios".

Comentar el código ayuda a identificar la causa de un error en el código. También se pueden usar para probar diferentes bloques de código para obtener diferentes resultados:

// función para dividir dos números
División de funciones (dividendo, divisor)
Let Cociente = dividend / divisor;
regresar cociente;

// función para restar dos números
función de función (num1, num2)
Sub = num1 - num2;
regreso sub;

/* En la siguiente línea de código, estamos comentando la llamada de función de la función de división. Por lo tanto, solo se llamará y ejecutará la función subtracción (). */
// división (30, 5);
multiplicarwonumber (9, 3);

Prácticas para escribir un buen código JavaScript

Aquí discutiremos las tres mejores prácticas para escribir un buen código JavaScript:

Los comentarios generalmente se escriben sobre el bloque del código que están explicando:

// Show "Hola, Linuxhint!"En la consola
consola.Log ("Hola, Linuxhint!");

Comentarios de sangría al mismo nivel que el código inmediatamente debajo de ellos:

// Definición de funciones
función showUser ()
// Retirando el nombre del usuario
name const = documento.getElementById ('Nombre de usuario');
// imprima el mensaje en la consola
consola.Log ("Hola y bienvenido al Linuxhint.com, " + nombre +".");

Recuerde que no hay forma de terminar los comentarios en línea; Por lo tanto, deben escribirse solo después de que el código para esa línea se haya escrito por completo:

para (dejar i = 0; i === 10; i ++) // para bucle que se ejecuta diez veces
// La ejecución de este código da como resultado un error de sintaxis

Conclusión

¿Cuántas veces ha resuelto un problema complejo escribiendo algún código solo para volver unos meses después y descubrir que no recuerda y no entiende nada?? Los comentarios lo ayudan a evitarlo escribiendo explicaciones/descripciones detalladas de su código. También ayudan a depurar las pruebas y identificar la fuente de errores en su código. Se pueden usar comentarios tanto individuales como multilíneas para fines de depuración/prueba. Si usted es un desarrollador de JavaScript para principiantes, debe escribir tantos comentarios como sea posible en su código, ya que son necesarios para comprender el código que escribe; Pero recuerde que solo deben agregarse donde son necesarios.