Què són els comentaris HTML i com s'utilitzen?
a Quan visualitzeu una pàgina web en un navegador, esteu veient una representació visual del que aquesta peça de programari (el navegador web) està mostrant en funció del codi d'una pàgina web en particular. Si veieu aquest codi font de la pàgina web, veureu un document format per diversos elements HTML, inclosos els paràgrafs, els encapçalaments, les llistes, els enllaços, les imatges i molt més. Tots els elements són representats pel navegador a la pantalla d'un visitant com a part de la visualització del lloc web. Una cosa que pot trobar en codi HTML que no es representa a la pantalla d'una persona són els anomenats "comentaris HTML".
Què és un comentari?
Un comentari és una cadena de codi dins d'HTML, XML o CSS que el navegador o l'analitzador no visualitza ni aplica. S'ha escrit simplement al codi per proporcionar informació sobre aquest codi o altres comentaris dels desenvolupadors de codi.
La majoria dels llenguatges de programació tenen comentaris, que sovint són utilitzats pel desenvolupador del codi per un o més d'un, del següent motiu:
- Descriure i explicar codi complicat a algú que pugui haver de treballar en el futur, inclosos ells mateixos. Poden tornar al codi 3 o 6 de 12 mesos o més després i no recordar per què van fer alguna cosa d'una manera determinada. Els comentaris poden ajudar-los a respondre les seves preguntes i recordar-los de la seva ment quan van començar a desenvolupar aquesta pàgina.
- Proporcioneu detalls sobre quan es va editar o revisar el codi. Pot ser útil informació i actuar de manera semblant a un registre de desenvolupament quan es va dur a terme un lloc.
- Elimineu les seccions del codi, però deixeu-les disponibles per al seu ús posterior. Això es fa sovint durant les proves del lloc i la depuració. Si teniu algun problema en un lloc i no esteu segur de què està causant, podeu comentar les seccions una a la vegada per a la quarentena i identificar el problema i, a continuació, treballar amb una solució per als problemes que tingueu.
- Xateja amb altres desenvolupadors que treballen en el codi. Probablement, això es realitzi durant el desenvolupament com a forma de compartir dades amb altres persones que treballen al codi alhora. Si aquests comentaris són converses purament de desenvolupament, és una pràctica recomanada eliminar-los del codi abans de llançar un lloc.
Tradicionalment, els comentaris en HTML s'utilitzen per a gairebé qualsevol element, des d'explicacions d'estructures de taula complexes fins a comentaris informatius del contingut de la pàgina en si. Com que els comentaris no es representen en un navegador, podeu afegir-los a qualsevol part del codi HTML i no tindreu cap preocupació sobre el que farà quan un client ho vegi.
Com escriure comentaris
Escriure comentaris en HTML, XHTML i XML és molt senzill. Simplement envolta el text que vols comentar amb el següent:
i ->Com podeu veure, aquests comentaris comencen amb un "menys del símbol", a més d'un punt d'exclamació i dos guions. El comentari finalitza amb dos guions més i un "més gran que: símbol. Entre aquests caràcters podeu escriure el que vulgueu fer el cos del comentari.
En CSS, és una mica diferent, usant els comentaris de codi C en comptes d'HTML. Comenceu amb una barra inclinada seguida d'un asterisc. Acaba el comentari amb la inversa, un asterisc seguit d'una barra inclinada cap endavant.
/ * text comentat * /Els comentaris són un art moribund
La majoria dels programadors coneixen el valor dels comentaris útils . El codi comentat facilita que aquest codi es transfereixi d'un membre de l'equip a un altre. Els comentaris us ajuden a l'equip de QA per provar el codi, perquè poden saber què volia el desenvolupador, fins i tot si no es va aconseguir. Malauradament, amb la popularitat de les plataformes de creació de llocs web com Wordpress, que us permeten posar-vos en funcionament amb un tema triat que gestiona molt, si no tot, l'HTML per a vosaltres, els comentaris no són utilitzats amb tanta freqüència pels equips web. Això és degut a que els comentaris són realment difícils de veure en la majoria d'eines de creació visual si no esteu treballant directament amb el codi. Per exemple, en comptes de veure, a la part superior d'una pàgina web:
L'eina visual mostra una petita icona per indicar que hi ha un comentari. Si el dissenyador no obre físicament el comentari, mai no ho veurà. I en el cas de la pàgina anterior, podria causar problemes si edita la pàgina i que l'edició s'escriu massa per l'script mencionat en el comentari.
Què es pot fer?
- Escriure comentaris significatius i útils. No espereu que altres persones llegeixin els vostres comentaris si són massa llargs o que no inclouen informació útil.
- Com a desenvolupador, sempre haureu de revisar qualsevol comentari que vegeu en una pàgina.
- Utilitzeu les eines proporcionades pels programes de creació personalitzada que us permeten afegir comentaris.
- Utilitzeu la gestió de contingut per controlar com s'editen les pàgines.
Fins i tot si sou l'única persona que edita les vostres pàgines web, els comentaris poden ser útils. Si només editeu una pàgina complicada una vegada a l'any, és fàcil oblidar-vos de com vau crear la taula o de configurar el CSS. Amb comentaris, no cal recordar, ja que està escrit allà mateix per a vostè.
Article original de Jennifer Krynin. Editat per Jeremy Girard el 5/5/17