¿Cuántas veces no te ha pasado que revisas tu código un tiempo despues y no sabes para qué sirve una función o por que escribiste ese fragmento de código? , y si trabajas en equipo es casi que obligatorio documentar todas las funciones o métodos para que otros desarrolladores entiendan su función y parámetros que recibe. Cuando documentas tu código de forma correcta ahorraras mucho tiempo cuando busques una funcionalidad o quieres refactorizar tu producto.
Comentarios de una línea
Para escribir comentarios linea por linea , ya sea para documentar una variable o dejar un comentario importante en una parte del código se usan las dobles barras inclinadas (//) Veamos un ejemplo:
function saludar(nombre){
// Se mostrará una ventana emergente saludando (Esto es un comentario :) )
alert(nombre);
}
Comentarios en bloque o multilínea
Para dejar un comentario un poco más extenso y en múltiples líneas iniciaremos usando barra inclinada y asterisco (/*) y por cada línea iniciaremos con asterisco (*) y al finalizar ponemos asterisco y barra inclinada (*/) Veamos un ejemplo
/* Función para saludar mostrando una ventana emergente
* Parámetros que recibe:
* nombre: Es el nombre de la persona que queremos saludar
* Este es un comentario de bloque o multilínea de ejemplo en javascript
*/
function saludar(nombre){
alert(nombre);
}
Comentarios