Cómo comentar en Angular
Comentar el código en Angular es fundamental para mejorar la legibilidad y el mantenimiento del proyecto. Dependiendo del tipo de archivo, los comentarios pueden variar.
Comentarios en TypeScript (.ts)
En los archivos TypeScript, se pueden usar dos tipos de comentarios:
- Comentario de una línea:
// Este es un comentario de una línea
let mensaje = 'Hola, Angular';- Comentario de varias líneas:
/*
* Este es un comentario
* de múltiples líneas
*/
function saludar() {
console.log('Hola, Angular');
}- Comentarios JSDoc: (Para documentar clases y métodos)
/**
* Clase que maneja la lógica del componente
*/
export class MiComponente {
/**
* Método que imprime un mensaje en consola
*/
mostrarMensaje(): void {
console.log('Mensaje desde el componente');
}
}
Comentarios en HTML (.html)
En las plantillas HTML de los componentes, los comentarios se escriben así:
<!-- Este es un comentario en HTML -->
<p>Hola, Angular</p>Los navegadores no mostrarán estos comentarios en la interfaz de usuario.
Comentarios en CSS y SCSS (.css o .scss)
En los archivos de estilos, se utilizan comentarios de la siguiente forma:
- En CSS y SCSS:
/* Este es un comentario en CSS o SCSS */
p {
color: blue;
}- En SCSS (comentario no incluido en el CSS compilado):
// Este comentario solo aparece en SCSS
$color-primario: blue;Ejemplos de uso
- Explicar lógica de código en TypeScript
- Ocultar temporalmente partes de HTML
- Documentar funciones y clases con JSDoc
Jorge García
Fullstack developer