El marcado HTML comentado correctamente es una parte importante de una página web bien construida. Esos comentarios son fáciles de agregar, y cualquier persona que tenga que trabajar en el código de ese sitio en el futuro (incluido usted o los miembros de cualquier equipo con el que trabaje) le agradecerá esos comentarios.
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 usar un programa centrado en el diseño web como Adobe Dreamweaver o incluso una plataforma de CMS como Wordpress o ExpressionEngine. Independientemente de la herramienta que use para crear HTML, si está trabajando directamente con el código, agregaría comentarios HTML como este:
-
Agregue la primera parte de la etiqueta de comentario HTML:
-
Entonces, en total, tu comentario se verá así:
-
Es realmente tan simple.
La pantalla 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, ese texto de comentario no aparecerá en el navegador web cuando un visitante normal llegue al sitio. A diferencia de otros elementos HTML, incluidos párrafos, encabezados o listas, que realmente afectan la página dentro de esos navegadores, los comentarios son realmente piezas "detrás de la escena" de la página.
Comentarios para fines de prueba
Debido a que los comentarios no aparecen en un navegador web, se pueden usar para "desactivar" partes de una página durante la prueba o el desarrollo de la página. Si agrega la parte inicial de un comentario directamente antes de la parte de su página / código que desea ocultar, y luego agrega la parte final al final de ese código (los comentarios HTML pueden abarcar varias líneas, por lo que puede abrir una comente en la línea 50 de su código y ciérrelo 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 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 para eliminarla. Con los comentarios, si la sección del código en cuestión demuestra que no es el problema, puede eliminar fácilmente los comentarios y ese código se mostrará una vez más. Solo asegúrese de que estos comentarios que se utilizan para las pruebas no se conviertan en sitios web de producción.
Si no se muestra un área de una página, desea eliminar el código, no solo comentarlo, antes de iniciar ese sitio.
Un gran uso de los comentarios HTML durante el desarrollo es cuando está construyendo un sitio web sensible. Debido a que diferentes partes de ese sitio cambiarán su apariencia según diferentes tamaños de pantalla, incluidas algunas áreas que pueden no mostrarse en absoluto, el uso de comentarios para activar o desactivar las secciones de una página puede ser un truco rápido y fácil de usar durante el desarrollo.
En cuanto a rendimiento
He visto a algunos profesionales de la web sugerir que los comentarios deberían eliminarse de los archivos HTML y CSS para reducir el tamaño de esos archivos y crear páginas de carga más rápida. Si bien estoy de acuerdo en que las páginas deben optimizarse 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 facilitar el trabajo en un sitio en el futuro, por lo tanto, siempre que no los deba con los comentarios agregados a cada línea de su código, la pequeña cantidad de tamaño de archivo agregada a una página se debe a Los comentarios deben ser más que aceptables.
Consejos para usar comentarios
Algunas cosas para tener en cuenta o recordar al usar comentarios HTML:
- Los comentarios pueden ser de varias líneas.
- Usa comentarios para documentar el desarrollo de tu página.
- Los comentarios también pueden documentar el contenido, filas o columnas de la tabla, hacer un seguimiento de los cambios o lo que quieras.
- Los comentarios que "apagan" las áreas de un sitio no deberían estar en producción a menos que este cambio sea temporal y se revertirá en poco tiempo (como activar o desactivar un mensaje de alerta según sea necesario).
