Cuando ve una página web en un navegador, está viendo una representación visual de lo que esa pieza de software (el navegador web) muestra en función del código de una página web en particular. Si ve el código fuente de la página web, verá un documento compuesto de varios elementos HTML, incluidos párrafos, encabezados, listas, enlaces, imágenes y más. Todos estos elementos son representados por el navegador en la pantalla de un visitante como parte de la visualización del sitio web. Una cosa que puede encontrar en el código HTML que no se representa en la pantalla de una persona es lo que se conoce como "comentarios HTML".
¿Qué es un comentario?
Un comentario es una cadena de código dentro de HTML, XML o CSS que el navegador o el analizador no ejecutan. Simplemente está escrito en el código para proporcionar información sobre ese código u otros comentarios de los desarrolladores del código.
La mayoría de los lenguajes de programación tienen comentarios, son comúnmente utilizados por el desarrollador del código para uno o incluso más de uno, por el siguiente motivo:
- Describa y explique el código complicado a alguien que quizás tenga que trabajar en él en el futuro, ¡incluidos ellos mismos! Pueden volver al código 3 o 6 de 12 meses o más después y no recordar por qué hicieron algo de cierta manera. Los comentarios pueden ayudar a responder sus preguntas y recordarles dónde se encontraban cuando estaban desarrollando esa página por primera vez.
- Proporcione detalles sobre cuándo se editó o revisó el código. Esta información puede ser útil y actuar como un registro de desarrollo de cuándo se trabajó un sitio por última vez.
- Elimine secciones del código, pero déjelas 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é lo está causando, puede comentar las secciones una a la vez para poner en cuarentena e identificar el problema, y luego trabajar en una solución para cualquier problema que tenga.
- Chatea con otros desarrolladores trabajando en el código. Esto probablemente se haría durante el desarrollo como una forma de compartir detalles con otras personas que trabajan en el código al mismo tiempo. Si estos comentarios son puramente conversaciones de desarrollo, es una buena práctica eliminarlos del código antes de lanzar un sitio.
Tradicionalmente, los comentarios en HTML se utilizan para casi cualquier elemento, desde explicaciones de estructuras de tablas complejas hasta comentarios informativos del contenido de la página en sí. Dado que los comentarios no se procesan en un navegador, puede agregarlos en cualquier parte del HTML y no tiene ninguna preocupación de lo que hará cuando el cliente vea el sitio.
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 "símbolo menos que", más un signo de exclamación y dos guiones. El comentario finaliza con dos guiones más y un símbolo "mayor que:". Entre esos caracteres puede escribir lo que quiera para formar el cuerpo del comentario.
En CSS, es un poco diferente, utilizando comentarios en código C en lugar de HTML. Usted comienza con una barra inclinada seguida de un asterisco. Usted termina el comentario con la inversa de eso, un asterisco seguido de una barra diagonal.
Los comentarios son un arte moribundo.
La mayoría de los programadores saben el valor de los comentarios útiles. El código comentado facilita la transferencia de dicho 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 pretendía el desarrollador, incluso si no se logró. Desafortunadamente, con la popularidad de plataformas de creación de sitios web como Wordpress, que le permiten ponerse en marcha con un tema elegido que maneja gran parte, si no todo, del HTML, los comentarios no se usan tan a menudo por los equipos web. Esto se debe a que los comentarios son realmente difíciles de ver en la mayoría de las herramientas de creación visual si no está 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 allí. Si el diseñador no abre físicamente el comentario, puede que nunca lo vea. Y en el caso de la página anterior, podría causar problemas si ella edita la página y esa edición se sobrescribe con la secuencia de comandos mencionada en el comentario.
¿Qué se puede hacer?
- Escribe 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ías siempre Revisa cualquier comentario que veas en una página.
- Utilice las herramientas proporcionadas por los programas de creación que le permiten agregar comentarios.
- Utilice la gestión de contenido para controlar cómo se editan las páginas.
Incluso si eres la única persona que edita tus páginas web, los comentarios pueden ser útiles. Si solo edita una página complicada una vez al año, es fácil olvidar cómo construyó la tabla o cómo armó el CSS. Con los comentarios, no tiene que recordar, ya que está escrito allí para usted.
