Cales son os comentarios HTML e como se usan?
Cando se ve unha páxina web nun navegador, está a ver unha representación visual do que está a amosar nesta peza de software (navegador web) en función do código dunha páxina web particular. Se ves ese código fonte da páxina web, verás un documento composto por varios elementos HTML, incluíndo parágrafos, títulos, listas, ligazóns, imaxes e moito máis. Todos os elementos son prestados polo navegador na pantalla dun visitante como parte da visualización do sitio web. Unha cousa que podes atopar en código HTML que non se representa na pantalla dunha persoa son os que se denominan "comentarios HTML".
¿Que é un comentario?
Un comentario é unha cadea de código dentro de HTML, XML ou CSS que non é visto nin axustado polo navegador ou o analizador. Simplemente escríbese no código para proporcionar información sobre ese código ou outros comentarios dos desenvolvedores de código.
A maioría dos idiomas de programación teñen comentarios, son utilizados polo desarrollador do código por un ou máis de un, polo seguinte motivo:
- Describe e explica código complicado a alguén que poida ter que traballar nela no futuro - incluídos eles mesmos. Poden volver ao código 3 ou 6 de 12 meses ou máis despois e non recordar por que fixeron algo de certa forma. Os comentarios poden axudar a responder as súas preguntas e recordarlles de onde estaba a súa mente cando desenvolveron a primeira páxina.
- Proporcione detalles sobre cando se editou ou revisou o código. Isto pode ser útil e actúa como un rexistro de desenvolvemento cando se traballou por última vez.
- Elimina as seccións do código, pero déixalles dispoñibles para o uso posterior. Isto faise frecuentemente durante a proba e a depuración do sitio. Se tes un problema nun sitio e non estás seguro do que o está a causar, podes comentar as seccións dunha soa vez a cuarentena e identificar o problema e, a continuación, traballar nun arranxo por calquera problema que teña.
- Chatea con outros desenvolvedores que traballan no código. Isto probablemente fose feito durante o desenvolvemento como forma de compartir detalles con outros que traballan no código ao mesmo tempo. Se estes comentarios son puramente conversas de desenvolvemento, é unha boa práctica eliminar-los do código antes de que se inicie un sitio.
Tradicionalmente, os comentarios en HTML úsanse para case calquera elemento, desde explicacións de estruturas complexas de mesas ata comentarios informativos do contido da propia páxina. Xa que os comentarios non se renderizan nun navegador, podes agregarlos en calquera parte do HTML e non te preocupes do que fará cando o cliente vexa o sitio.
Como escribir comentarios
Escribir comentarios en HTML, XHTML e XML é moi sinxelo. Simplemente rodea o texto que desexa comentar co seguinte:
e ->Como podes ver, estes comentarios comezan cun "menos do símbolo", máis un punto de exclamación e dous guións. O comentario termina con dous guiones e un "maior que: símbolo. Entre eses personaxes pode escribir o que quere facer o corpo do comentario.
En CSS, é un pouco diferente, usando comentarios de código C en vez de HTML. Comézase cunha barra dianteira seguida dun asterisco. Vostede remata o comentario coa inversa, un asterisco seguido por unha barra dianteira.
/ * texto comentado * /Os comentarios son unha arte moribunda
A maioría dos programadores coñecen o valor dos comentarios útiles . O código comentado facilita a transferencia do código desde un membro do equipo a outro. Os comentarios axúdanche ao equipo de QA para probar o código, porque poden dicir o que desexaba o desarrollador, aínda que non se lograse. Desafortunadamente, coa popularidade de plataformas de creación de sitios web como Wordpress, que lle permiten instalarse e funcionar cun tema escollido que manexa moito, se non todo, o HTML para ti, os comentarios non se usan con tanta frecuencia por equipos web. Isto ocorre porque os comentarios son realmente difíciles de ver na maioría das ferramentas de creación visual se non traballas directamente co código. Por exemplo, en lugar de ver, na parte superior dunha páxina web:
A ferramenta visual mostra un pequeno ícono para indicar que hai un comentario. Se o diseñador non abre físicamente o comentario, nunca pode velo. E no caso da páxina anterior, podería causar problemas se edita a páxina e que a edición está escrita por escrito polo guión mencionado no comentario.
Que se pode facer?
- Escriba comentarios útiles e útiles. Non espere que outras persoas poidan ler os seus comentarios se son demasiado longos ou non inclúen información útil.
- Como desarrollador, sempre debes revisar os comentarios que ve nunha páxina.
- Utiliza as ferramentas proporcionadas polos programas de creación que permiten engadir comentarios.
- Use a xestión de contido para controlar como se editan as páxinas.
Aínda que es a única persoa que edita as túas páxinas web, os comentarios poden ser útiles. Se só edita unha páxina complicada unha vez ao ano, é fácil esquecer como construíu a táboa ou xuntou o CSS. Con comentarios, non tes que recordar, xa que está escrito alí para ti.
Artigo orixinal de Jennifer Krynin. Editado por Jeremy Girard o 5/5/17