wikipediaillustrated

marketing

Cómo comentar y comentar en HTML

Developer adding comments in HTML.jpgkeepProtocol

Al igual que los comentarios en CSS, agregar comentarios a su HTML puede ayudarlo a escribir y organizar el backend de su página web.

Puede agregar comentarios para explicar su código, lo que facilitará la edición en el futuro o el trabajo con otros desarrolladores. También puede usar comentarios para simplificar sus esfuerzos de depuración.

Veamos más de cerca qué es un comentario en HTML y luego definamos qué significa «comentar» en HTML.

Gracias a la etiqueta de comentarios, puede dejar notas para recordar dónde lo dejó en el proceso de creación. Puede explicar la funcionalidad prevista de una sección de código, ya sea para otro desarrollador o para usted mismo en el futuro.

También puede comunicarse con otros desarrolladores que trabajan simultáneamente en el mismo código. Puede dejar una advertencia para que solo ejecuten una determinada función por la noche porque lleva mucho tiempo ejecutarla. O puede asignarles una tarea o señalarles un error con un comentario.

En resumen, comentar en HTML puede ayudarlo a trabajar mejor y de manera más inteligente al crear, depurar o rediseñar un sitio web. Veamos un ejemplo.

Ejemplo de comentario HTML

Digamos que está creando un sitio web Bootstrap con un equipo de desarrolladores. Desea dejar una nota para recordarles que todos los botones de Bootstrap deben usar la clase de modificador principal para que todos sean del mismo color.

Así es como se vería su HTML, así como el resultado en la interfaz:

ver la pluma xxgWwoa de Christina Perricone (@hubspot) en CódigoPen.

Como puede ver arriba, el comentario se oculta con éxito en la parte delantera.

Ahora que entendemos cómo comentar en HTML, veamos cómo comentar.

Comentar tiene dos propósitos principales. Uno está depurando su código. Al descubrir un error, puede comentar sus primeras líneas de código, verificar si el error aún ocurre y seguir repitiendo el proceso hasta que se aísle el código con errores.

El segundo propósito tiene que ver con el historial de versiones. Dado que comentar significa que el código permanecerá visible en el back-end, puede ser una forma de mostrar diferentes iteraciones de la base de código para los nuevos desarrolladores que recién se unen o han heredado el proyecto web.

Veamos un ejemplo. Digamos que estoy creando una página en Bootstrap: tengo una barra de navegación, un encabezado, un párrafo y un botón.

Aquí está el HTML y cómo se ve la página en la parte delantera:

ver la pluma Página de Bootstrap con barra de navegación y botón de Christina Perricone (@hubspot) en CódigoPen.

Tal vez previsualizo mi trabajo y descubro que hay un error. En ese caso, puedo comentar cada elemento para aislar qué sección del código contiene el error.

O tal vez ejecuto algunas pruebas A/B y descubro que el botón no recibe ningún clic y quiero eliminarlo. En ese caso, podría comentarlo, dejando una nota de que un botón CTA en la página inferior no se convirtió. Luego, la próxima persona que venga e intente optimizar la tasa de conversión en la página sabrá que debe comenzar con otra ubicación de botón.

Código comentado

Para «comentar» un botón, o cualquier elemento HTML, simplemente envuelva el elemento en las etiquetas < !╌ ╌>. Todo lo que hay entre esas etiquetas no se mostrará en la parte delantera.

 
<!--Button wasn’t converting so removed in July <button class="btn btn-primary" type="submit">Button</button>-->

El resto del código seguirá siendo el mismo. Todo en la parte delantera también se verá igual, excepto el botón. Puedes verlo por ti mismo a continuación.

ver la pluma yLgKeYz de Christina Perricone (@hubspot) en CódigoPen.

Dejar comentarios en su HTML

Los comentarios son otra forma en que puede «hablar» con las personas en su código. Puedes agregar notas explicativas para otros colaboradores en un proyecto web, o puedes dejarte notas que te recuerden volver a una sección o priorizarla durante tu próximo rediseño. ¿La mejor parte? Los comentarios no aparecerán en la parte frontal de su sitio y son fáciles de dominar, incluso si recién está comenzando a aprender HTML y CSS.

Nueva llamada a la acción

introducción css

Publicado originalmente el 12 de abril de 2021 a las 7:00:00 a. m., actualizado el 23 de agosto de 2021

Temas:

HTML

Puede que también te guste...

Deja una respuesta

Tu dirección de correo electrónico no será publicada.