¿Qué es un comentario en javascript?
Un comentario es una forma de documentar y anotar lo que hace nuestro código por ejemplo si escribo una función para filtrar una array de objetos puede ser de gran utilidad dejar algunas notas sobre algún proceso importante que realice nuestra función.
A pesar de que comentar tu código puede parecer una buena práctica tampoco debemos abusar de ello.
Ya que si dejamos muchos comentarios nuestro código se verá sucio y dependiendo de lo largo que sea, podría convertirlo en un código complicado de leer.
Más adelante tienes algunos consejos para utilizar de forma correcta los comentarios.
Tipos de comentarios en javascript
Existen dos formas de comentar nuestro código en js
Poner comentarios de una línea en js
Este tipo de comentarios tal y como su nombre lo indica cubren solo una línea del código y para utilizarlos debes anteponer dos barras como estas // este tipo de comentario se suele utilizar para explicar el código de la siguiente línea.
js
//Esto es un comentario de una línea// Esta variable guarda una cadena con un mensaje de bienvenidaconst saludo = "Hola bienvenido"; //también se puede poner un comentario después del código
Poner comentarios de múltiples líneas js
Este tipo de comentarios pueden cubrir varias líneas y suelen ser utilizados para explicar partes del código más complejas que requieren de una explicación mucho más profunda.
Se abren con una barra y un asterisco (/*) y se cierran con un asterisco y una barra (*/)
js
/*Esto es un comentario de múltiples líneasPara documentar partes del código complejas*/const saludo = "Hola bienvenido";
Consejos para Escribir Comentarios en JavaScript
Los comentarios son una parte esencial de cualquier código JavaScript. No solo ayudan a documentar tu código, sino que también facilitan la colaboración y el mantenimiento a largo plazo. Aquí tienes algunos consejos para escribir comentarios efectivos en JavaScript:
1. Sea Claro y Conciso
Cuando escribas comentarios, sé claro y conciso en tus explicaciones. Evita comentarios innecesariamente largos o complicados. Mantén tus comentarios directos y fáciles de entender.
Ejemplo:
js
// Mal: Este comentario es excesivamente largo y difícil de seguir.// Esto es un bucle que recorre la matriz de datos y suma los valores a la variable total.// Bien: Un comentario claro y conciso.// Sumar los valores de la matriz de datos a la variable total.
2. Utiliza Comentarios en Línea y de Bloque
En JavaScript, puedes usar comentarios en línea (//) y comentarios de bloque (/* */) según sea necesario. Los comentarios en línea son útiles para aclarar una línea específica de código, mientras que los comentarios de bloque son ideales para describir secciones más extensas de código.
Ejemplo:
js
// Comentario en línea: Aclaración de una línea específica de código./*Comentario de bloque: Puede describir secciones de código más extensas.Este es un ejemplo de un comentario de bloque.*/
3. Documenta la Funcionalidad
Asegúrate de explicar la funcionalidad del código, especialmente si es complejo o no es obvio. Describe qué hace el código y por qué es necesario.
Ejemplo:
js
// Calcula el promedio de los números en la matriz.function calcularPromedio(matriz) {// Suma los valores de la matriz y los divide por la cantidad de elementos.// Esto proporciona el promedio.}
4. Actualiza los Comentarios
A medida que hagas cambios en el código, asegúrate de mantener los comentarios actualizados para reflejar la funcionalidad actual. Los comentarios desactualizados pueden llevar a la confusión.
5. Evita Comentarios Obvios
Evita comentarios que simplemente repitan lo que hace el código. Los comentarios deben añadir información útil, no redundante.
Ejemplo:
js
// Mal: Comentario obvio.let x = 5; // Asigna 5 a la variable x.// Bien: Comentario informativo.let x = 5; // Número de intentos permitidos antes de bloquear el acceso.
Siguiendo estos consejos, podrás mejorar la calidad de tus comentarios en JavaScript y hacer que tu código sea más legible y fácil de mantener.
Soy Juneiker Castillo, un desarrollador web frontend apasionado por la programación y la creación de sitios web modernos rápidos y escalables, en fin un friki 🤓 de javascript enamorado de react js ⚛️.
Sobre mi