El marcat HTML correctament comentat és una part important d'una pàgina web ben construïda. Aquests comentaris són fàcils d'afegir, i qualsevol persona que hagi de treballar en el codi del lloc en el futur (inclòs vostè mateix o els membres de qualsevol equip amb qui treballi) us donarà les gràcies per aquests comentaris.
Com afegir comentaris HTML
HTML pot ser escrit amb un editor de text estàndard, com Notepad ++ per a Windows o TextEdit for a Ma. També podeu utilitzar un programa centrat en el disseny web com Adobe Dreamweaver o fins i tot una plataforma CMS com Wordpress o ExpressionEngine. Independentment de l'eina que utilitzeu per escriure HTML, si esteu treballant directament amb el codi, afegiu comentaris HTML com aquest:
- Afegiu la primera part de l'etiqueta de comentaris HTML:
- Després d'aquesta primera part del comentari, escriviu el text que vulgueu que aparegui per a aquest comentari. Probablement hi haurà instruccions per al vostre desenvolupador o un altre en el futur. Per exemple, si voleu designar on s'inicia una secció determinada d'una pàgina o si acaba en el marcatge, podeu utilitzar-ne un comentari per detallar-lo.
- Un cop completat el text del vostre comentari, tanqueu l'etiqueta de comentaris d'aquesta manera: ->
- Així que, en total, el vostre comentari es veurà així:
La presentació de comentaris
Qualsevol comentari que afegiu al vostre codi HTML apareixerà en aquest codi quan algú vegi l'origen de la pàgina web o si obre el codi HTML en un editor per fer alguns canvis. Tanmateix, aquest text de comentari no apareixerà al navegador web quan un visitant normal arribi al lloc. A diferència d'altres elements HTML, inclosos els paràgrafs, els encapçalaments o les llistes, que afecten la pàgina dins d'aquests navegadors, els comentaris són realment "darrere de les escenes" de la pàgina.
Comentaris per als propòsits de proves
Com que els comentaris no apareixen en un navegador web, es poden utilitzar per "desactivar" parts d'una pàgina durant la prova o el desenvolupament de la pàgina. Si afegiu la part inicial d'un comentari directament a la part de la vostra pàgina / codi que voleu ocultar i, a continuació, afegiu la part final al final d'aquest codi (els comentaris HTML poden abastar diverses línies, de manera que podeu obrir un feu comentaris a la línia 50 del vostre codi i tanqueu-lo a la línia 75 sense problemes), llavors els elements HTML que quedin dins d'aquest comentari ja no es mostraran al navegador. Es mantindran al vostre codi, però no afectaran la visualització visual de la pàgina. Si necessiteu provar una pàgina per veure si una determinada secció està provocant problemes, etc., comentar que la zona és preferible eliminar-la. Amb comentaris, si la secció del codi en qüestió demostra que no és el problema, podeu eliminar fàcilment les peces de comentari i aquest codi es mostrarà una vegada més. Només assegureu-vos que aquests comentaris que s'utilitzen per fer proves no els converteixin en llocs web de producció.
Si no s'ha de mostrar una àrea d'una pàgina, voleu eliminar el codi, i no només comentar-lo abans de publicar aquest lloc.
Un gran ús de comentaris HTML durant el desenvolupament és quan està construint un lloc web sensible . Atès que diferents parts d'aquest lloc canviaran la seva aparença en funció de diferents mides de pantalla , incloent-hi algunes àrees que no es poden mostrar, podeu activar o desactivar els comentaris per alternar les seccions d'una pàgina, que pot ser un truc ràpid i fàcil d'utilitzar durant el desenvolupament.
Pel que fa al rendiment
He vist que alguns professionals de la web suggereixen que els comentaris s'han d'eliminar dels fitxers HTML i CSS per tal d'afinar la mida d'aquests fitxers i crear pàgines de càrrega més ràpida. Encara que estic d'acord que les pàgines han de ser optimitzades per al rendiment i s'han de carregar ràpidament, encara hi ha un lloc per a l'ús intel·ligent dels comentaris en el codi. Recordeu que aquests comentaris estan destinats a facilitar el treball en un lloc en el futur, sempre que no l'hagueu adquirit amb comentaris afegits a totes les línies del vostre codi, la petita quantitat de mida del fitxer s'ha afegit a una pàgina deguda a els comentaris han de ser més que acceptables.
Consells per utilitzar comentaris
Algunes coses a tenir en compte o recordar quan s'utilitzen comentaris HTML:
- Els comentaris poden ser múltiples línies.
- Feu servir comentaris per documentar el desenvolupament de la vostra pàgina.
- Els comentaris poden al; així que documenteu contingut, files de taula o columnes, seguiu els canvis o el que vulgueu.
- Els comentaris que "desactiven" les àrees d'un lloc no han de fer-ho en producció, tret que aquest canvi sigui temporal que s'inverteixi a curt termini (per exemple, si es necessita un missatge d'alerta activat o desactivat).