El marcado HTML correctamente comentado es una parte importante de una página web bien construida. Esos comentarios son fáciles de añadir, y cualquiera que tenga que trabajar en el código de ese sitio en el futuro (incluyéndote a ti o a los miembros de cualquier equipo con el que trabajes) te agradecerá por esos comentarios.
Índice de contenidos
Cómo agregar comentarios HTML
HTML se puede crear con un editor de texto estándar, como Notepad++ para Windows o TextEdit para Mac. También puede utilizar un programa centrado en el diseño web como Adobe Dreamweaver o incluso una plataforma CMS como WordPress o ExpressionEngine. Independientemente de la herramienta que utilice para crear HTML, si está trabajando directamente con el código, agregará comentarios HTML de esta manera:
-
Añada la primera parte de la etiqueta de comentario HTML:
-
Así que en total, su comentario se parecerá a esto:
-
Es así de simple.
La visualización de comentarios
Cualquier comentario que agregue a su código HTML aparecerá en ese código cuando alguien vea la fuente de la página web o abra el HTML en un editor para hacer algunos cambios. Sin embargo, el texto de ese comentario no aparecerá en el navegador web cuando un visitante normal venga al sitio. A diferencia de otros elementos HTML, incluyendo párrafos, encabezados o listas, que realmente impactan la página dentro de esos navegadores, los comentarios son realmente piezas "entre bastidores" de la página.
Comentarios con fines de ensayo
Dado que los comentarios no aparecen en un navegador web, pueden utilizarse para "desactivar" partes de una página durante la prueba o el desarrollo de la página. Si agrega la parte de apertura de un comentario justo antes de la parte de su página/código que desea ocultar, y luego agrega la parte de cierre al final de ese código (los comentarios HTML pueden abarcar varias líneas, de modo que puede abrir un comentario en la línea 50 de su código y cerrarlo en la línea 75 sin problemas), entonces cualquier elemento HTML que caiga dentro de ese comentario ya no se mostrará en el navegador. Permanecerán en su código, pero no afectarán a la visualización de la página. Si necesita probar una página para ver si una determinada sección está causando problemas, etc., es preferible comentar esa área antes que borrarla. Con los comentarios, si la sección de código en cuestión resulta no ser el problema, puede eliminar fácilmente las piezas de comentario y ese código se mostrará una vez más. Sólo asegúrese de que estos comentarios que se utilizan para las pruebas no lleguen a los sitios web de producción.
Si un área de una página no debe ser mostrada, usted quiere eliminar el código, no sólo comentarlo, antes de lanzar ese sitio.
Un gran uso de los comentarios HTML durante el desarrollo es cuando se está construyendo un sitio web sensible. Debido a que diferentes partes de ese sitio cambiarán su apariencia en base a diferentes tamaños de pantalla, incluyendo algunas áreas que pueden no ser mostradas en absoluto, usar comentarios para activar o desactivar secciones de una página puede ser un truco rápido y fácil de usar durante el desarrollo.
Con respecto al rendimiento
He visto a algunos profesionales de la web sugerir que los comentarios deben ser eliminados de los archivos HTML y CSS con el fin de reducir el tamaño de esos archivos y crear páginas de carga más rápida. Aunque estoy de acuerdo en que las páginas deben ser optimizadas para el rendimiento y deben cargarse rápidamente, todavía hay un lugar para el uso inteligente de los comentarios en el código. Recuerde, estos comentarios tienen la intención de hacer más fácil trabajar en un sitio en el futuro, así que mientras no lo retrase con comentarios añadidos a cada línea de su código, la pequeña cantidad de tamaño de archivo añadida a una página debido a los comentarios debería ser más que aceptable.
Consejos para usar los comentarios
Algunas cosas a tener en cuenta o recordar cuando se utilizan comentarios HTML:
- Los comentarios pueden ser de varias líneas.
- Utilice los comentarios para documentar el desarrollo de su página.
- Los comentarios también pueden documentar contenido, filas o columnas de tablas, realizar un seguimiento de los cambios o lo que desee.
- Los comentarios de que las áreas de "desactivación" de un sitio no deben entrar en producción a menos que este cambio sea temporal y se invierta en poco tiempo (como tener un mensaje de alerta activado o desactivado según sea necesario).
