Debidamente comentado HTML el marcado es una parte importante de una página web bien construida. Esos comentarios son fáciles de agregar y cualquiera que tenga que trabajar en el código de ese sitio en el futuro (incluido usted mismo 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 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 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:
Después de esa parte inicial del comentario, escriba el texto que le gustaría que aparezca para este comentario. Es probable que estas sean instrucciones para usted u otro desarrollador en el futuro. Por ejemplo, si desea designar dónde comienza o termina una determinada sección de una página en el marcado, puede usar un comentario para detallarlo.
Una vez que el texto de su comentario esté completo, cierre la etiqueta de comentario de esta manera:
Entonces, en total, su comentario se verá así:
Realmente 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 ve la fuente de la página web o abre el HTML en un editor para realizar algunos cambios. Sin embargo, ese texto de comentario no aparecerá en el navegador web cuando los visitantes normales ingresen al sitio. A diferencia de otros elementos HTML, incluidos párrafos, encabezados o listas, que realmente impactan la página dentro de esos navegadores, los comentarios son realmente partes "detrás de escena" de la página.
Comentarios con fines de prueba
Dado que los comentarios no aparecen en un navegador web, se pueden utilizar 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 directamente antes de la parte de su página / código que desea ocultar, y luego agrega el parte de cierre al final de ese código (los comentarios HTML pueden abarcar varias líneas, por lo que puede abrir un comentario en la línea 50 de su código y ciérrelo en la línea 75 sin problemas), entonces los elementos HTML que se encuentren dentro de ese comentario ya no se mostrarán 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 que eliminarla. Con los comentarios, si la sección de 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 incluyan en los sitios web de producción. Si no se debe mostrar 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á compilando un sitio web receptivo. 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 secciones de una página puede ser un truco rápido y fácil de usar durante el desarrollo.
Respecto al rendimiento
He visto a algunos profesionales de la web sugerir que los comentarios deben 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 ser optimizado para el rendimiento y debería cargarse rápidamente, todavía hay un lugar para el uso inteligente de los comentarios en el código. Recuerde, estos comentarios están destinados a facilitar el trabajo en un sitio en el futuro, siempre y cuando no se exceda con comentarios agregados a cada línea en su código, la pequeña cantidad de tamaño de archivo agregado a una página debido a los comentarios debe ser más de aceptable.
Consejos para usar comentarios
Algunas cosas a tener en cuenta o recordar al usar comentarios HTML:
- Los comentarios pueden tener varias líneas.
- Utilice comentarios para documentar el desarrollo de su página.
- Los comentarios también pueden documentar el contenido, las filas o columnas de la tabla, realizar un seguimiento de los cambios o lo que desee.
- Los comentarios que "desactivan" áreas de un sitio no deben entrar en producción a menos que este cambio sea un temporal que se revertirá en poco tiempo (como tener un mensaje de alerta activado o desactivado como necesario).