Los comentarios en son fragmentos de texto que se incluyen en el código fuente pero no se muestran en el navegador web. Están diseñados para que los desarrolladores puedan añadir notas, explicaciones o instrucciones dentro del código sin afectar su funcionamiento.
Hoy vamos a ver cómo poner comentarios en algunos de los lenguajes más frecuentes a la hora de desarrollar una página web, como son HTML, CSS, PHP, JavaScript y VBScript. Ya seas diseñador, maquetador o programador, se trata de algo básico pero esencial a la hora de tener ordenado el código, sobre todo si el proyecto va a cambiar de manos. También es bastante útil para hacer pruebas sin tener que borrar código y ayudarnos a localizar más fácilmente problemas.
Comentarios en HTML
En HTML se utiliza una etiqueta de apertura y otra de cierre (<!--
-->
), todo lo que se encuentre entre estas dos será interpretado por el navegador como un comentario. Los comentarios en HTML pueden incluir cualquier texto dentro de estas etiquetas y pueden ocupar varias líneas si es necesario.
<!-- comentario en HTML -->
Como nota, comentar que a veces se utilizan los comentarios HTML para evitar que los navegadores antiguos que no reconocen lenguajes de secuencias de comandos (como JavaScript), intenten interpretar el código y se produzca un error.
Comentarios en CSS
Para las hojas de estilo también se usa apertura y cierre, pero cambiando las etiquetas (/*
*/
). Los comentarios en CSS se utilizan normalmente para explicar el propósito de reglas específicas, dar contexto a partes del código y documentar decisiones de diseño.
/* comentario en CSS */
En este caso los comentarios pueden abarcar también una sola o múltiples líneas de texto.
Comentarios en PHP y JavaScript
Si trabajamos en PHP o JavaScript existen dos tipos de comentarios. El primero es con apertura y cierre (/*
*/
), con idea de que puedas comentar trozos completos de código con varias líneas. El segundo tipo es para que puedas comentar una única línea y se pone al comienzo de la misma (//)
/*
función(ejemplo){
comentario de varias líneas en PHP y JavaScript
}
*/
// comentario en una sola línea PHP y JavaScript
Comentarios en VBScript
VBScript permite también comentar usando dos tipos diferentes (REM y comilla simple). Sin embargo, ambos se usan para comentar una única línea.
REM comentario en VBScript
' comentario en VBScript
Decir que los comentarios no solo no son visibles para los usuarios, tampoco son indexados por los buscadores, por lo tanto las anotaciones que hagamos no serán rastreadas.
Deja una respuesta