Cuando usted ve una página web en un navegador, está viendo una representación visual de lo que esa pieza de software (el navegador web) está mostrando basado en el código de una página web en particular. Si usted ve ese código fuente de la página web, verá un documento compuesto de varios elementos HTML, incluyendo párrafos, encabezados, listas, enlaces, imágenes y más. Todos estos elementos son mostrados por el navegador en la pantalla del visitante como parte de la visualización del sitio web. Una cosa que puedes encontrar en el código HTML que no se muestra en la pantalla de una persona es lo que se conoce como «comentarios HTML».
Índice de contenidos
¿Qué es un comentario?
Un comentario es una cadena de código dentro de HTML, XML, o CSS que no es visto o actuado por el navegador o analizador. Simplemente se escribe en el código para proporcionar información sobre ese código u otros comentarios de los desarrolladores de código.
La mayoría de los lenguajes de programación tienen comentarios, son comúnmente usados por el desarrollador del código para uno o incluso más de uno, por la siguiente razón:
- Describa y explique el código complicado a alguien que pueda tener que trabajar en él en el futuro – ¡incluyéndose a sí mismo! Pueden volver al código 3 o 6 de 12 meses o más tarde y no recordar por qué hicieron algo de cierta manera. Los comentarios pueden ayudar a responder sus preguntas y recordarles dónde estaba su mente cuando desarrollaron esa página por primera vez.
- Proporcione detalles sobre cuándo se editó o revisó el código. Esto puede ser información útil y actuar como un registro de desarrollo de cuando se trabajó por última vez en un sitio.
- Elimina secciones del código, pero déjalas disponibles para su uso posterior. Esto se hace a menudo durante las pruebas y depuración del sitio. Si tiene un problema en un sitio y no está seguro de qué es lo que lo está causando, puede comentar las secciones una por una para poner en cuarentena e identificar el problema, y luego trabajar en una solución para cualquier problema que esté teniendo.
- Chatea con otros desarrolladores que trabajan en el código. Esto probablemente se haría durante el desarrollo como una forma de compartir detalles con otros que trabajan en el código al mismo tiempo. Si estos comentarios son conversaciones puramente de desarrollo, es una buena práctica eliminarlos del código antes de que se lance un sitio.
Tradicionalmente, los comentarios en HTML se utilizan para casi todos los elementos, desde explicaciones de estructuras de tablas complejas hasta comentarios informativos del contenido de la propia página. Dado que los comentarios no se muestran en un navegador, puede añadirlos en cualquier parte del HTML y no tiene que preocuparse de lo que hará cuando el sitio sea visto por un cliente.
Cómo escribir comentarios
Escribir comentarios en HTML, XHTML y XML es muy fácil. Simplemente rodee el texto que desea comentar con lo siguiente:
y
Como puede ver, estos comentarios comienzan con un «menos que símbolo», más un signo de exclamación y dos guiones. El comentario termina con dos guiones más y un símbolo «más que:». Entre esos caracteres puedes escribir lo que quieras para formar el cuerpo del comentario.
En CSS, es un poco diferente, usando comentarios en código C en lugar de HTML. Comienza con una barra oblicua seguida de un asterisco. Terminas el comentario con lo contrario, un asterisco seguido de una barra oblicua.
Los comentarios son un arte moribundo
La mayoría de los programadores conocen el valor de los comentarios útiles. El código comentado facilita la transferencia de ese código de un miembro del equipo a otro. Los comentarios ayudan al equipo de control de calidad a probar el código porque pueden decir lo que el desarrollador pretendía, incluso si no se ha conseguido. Desafortunadamente, con la popularidad de las plataformas de creación de sitios web como Wordpress, que le permiten ponerse en marcha con un tema elegido que maneja mucho, si no todo, del HTML para usted, los comentarios no son utilizados tan a menudo por los equipos de la web. Esto se debe a que los comentarios son realmente difíciles de ver en la mayoría de las herramientas de autoría visual si no estás trabajando directamente con el código. Por ejemplo, en lugar de ver, en la parte superior de una página web:
La herramienta visual muestra un pequeño icono para indicar que hay un comentario. Si el diseñador no abre físicamente el comentario, es posible que nunca lo vea. Y en el caso de la página anterior, podría causar problemas si edita la página y que la edición es sobreescrita por el script mencionado en el comentario
.
¿Qué se puede hacer?
- Escriba comentarios significativos y útiles. No espere que otras personas lean sus comentarios si son demasiado largos o no incluyen información útil.
- Como desarrollador, debería revisar siempre cualquier comentario que vea en una página.
- Utilice las herramientas proporcionadas por los programas de creación que le permiten añadir comentarios.
- Utilice la gestión de contenidos para controlar cómo se editan las páginas.
Incluso si usted es la única persona que edita sus páginas web, los comentarios pueden ser útiles. Si sólo editas una página complicada una vez al año, es fácil olvidar cómo construiste la tabla o cómo armaste el CSS. Con los comentarios, usted no tiene que recordar, ya que está escrito justo ahí para usted.
