comentarios en javascript

Para crear un comentario de una sola línea en JavaScript, coloque dos barras oblicuas “//” delante del código o texto que desea que el intérprete de JavaScript ignore. Cuando coloques estas dos barras oblicuas, todo el texto a su derecha será ignorado, hasta la siguiente línea.

Los comentarios en JavaScript se pueden utilizar para explicar el código JavaScript y hacerlo más fácil de entender.

Los comentarios JavaScript también pueden ser usados para prevenir la ejecución, cuando se prueba un código alternativo.

Comentarios de una sola línea

leer codigo facil

Los comentarios de una sola línea comienzan con //.

Cualquier texto entre // y el final de la línea será ignorado por JavaScript (lo que quiere decir que no se ejecutará).

Este ejemplo utiliza un comentario de una sola línea antes de cada línea de código:

Ejemplo

// Change heading:
document.getElementById(“myH”).innerHTML = “My First Page”;

// Change paragraph:
document.getElementById(“myP”).innerHTML = “My first paragraph.”;

Este ejemplo utiliza un comentario de una sola línea al final de cada línea para explicar el código:

Ejemplo:

var x = 5;      // Declare x, give it the value of 5
var y = x + 2;  // Declare y, give it the value of x + 2

Comentarios de varias líneas

Los comentarios de varias líneas comienzan con /* y terminan con */.

Cualquier texto entre /* y */ será ignorado por JavaScript.

Este ejemplo utiliza un comentario de varias líneas (un bloque de comentarios) para explicar el código:

Ejemplo:

/*
The code below will change
the heading with id = “myH”
and the paragraph with id = “myP”
in my web page:
*/
document.getElementById(“myH”).innerHTML = “My First Page”;
document.getElementById(“myP”).innerHTML = “My first paragraph.”;

Nota:

Es más común usar comentarios de una sola línea.
Los comentarios de bloque se utilizan a menudo para la documentación formal.

Uso de comentarios para evitar la ejecución de código

El uso de comentarios para evitar la ejecución de código es adecuado para las pruebas de código.

Añadir // delante de una línea de código cambia las líneas de código de una línea ejecutable a un comentario.

Este ejemplo utiliza // para evitar la ejecución de una de las líneas de código:

Ejemplo

//document.getElementById(“myH”).innerHTML = “My First Page”;
document.getElementById(“myP”).innerHTML = “My first paragraph.”;

Este ejemplo utiliza un bloque de comentarios para evitar la ejecución de múltiples líneas:

Ejemplo

/*
document.getElementById(“myH”).innerHTML = “My First Page”;
document.getElementById(“myP”).innerHTML = “My first paragraph.”;
*/

Malas prácticas

A veces los novatos abusan de los comentarios en el codigo y te puedes encontrar cosas como esta:

// Este código hará esto (…) y aquello (…)
// …y quién sabe qué más…

Pero en un buen código, la cantidad de estos comentarios “explicativos” debería ser mínima. En serio, el código debería ser fácil de entender sin tanto comentario.

Hay una gran regla sobre eso: “si el código es tan poco claro que requiere un comentario, entonces tal vez debería ser reescrito“.

Se que en realidad no podemos evitar totalmente los comentarios “explicativos”. Porque hay algunos algoritmos tan complejos que nos obligan a tener comentarios si o si.

Y hay “ajustes” inteligentes para fines de optimización. Pero en general debemos tratar de mantener el código simple y limpio lo maximo posible, y eso se consigue con las buenas practicas en los comentarios.

Buenas practicas

Describa la arquitectura sobretodo.

Trate de proporcionar una visión general de alto nivel de los componentes: cómo interactúan entre si, cuál es el flujo de control en diversas situaciones…

En resumen – la vista de pájaro del código. Hay un lenguaje especial de diagramas UML para diagramas de arquitectura de alto nivel. Definitivamente vale la pena estudiarlo.

Una buena señal de un buen desarrollador de codigo suele ser en los comentarios: notar su presencia e incluso su ausencia.

Los buenos comentarios nos permiten mantener bien comprensivo el código, volver a él después de un tiempo y volver a usarlo como si no hubiera pasado tanto tiempo, de forma efectiva.

Solo procure comentar cosas como:

Arquitectura general, vista de alto nivel. Utilización de funciones. Soluciones importantes, especialmente cuando no son inmediatamente obvias.

Evite comentarios como estos:

Que dicen “cómo funciona el código” y “qué hace”. Ponerlos sólo si es imposible hacer el código tan simple y autodescriptivo que no requiera de ellos.

Show Comments

No Responses Yet

Leave a Reply