Como engadir comentarios no teu HTML

O marcado HTML correctamente comentado é unha parte importante dunha páxina web ben construída. Eses comentarios son fáciles de engadir e calquera persoa que teña que traballar no código deste sitio no futuro (incluídos os membros ou membros de calquera equipo co que traballas) agradeceranche os comentarios.

Como engadir comentarios HTML

O HTML pode ser escrito cun editor de texto estándar, como Notepad ++ para Windows ou TextEdit for a Ma. Tamén pode usar un programa de deseño web centrado como Adobe Dreamweaver ou mesmo unha plataforma CMS como Wordpress ou ExpressionEngine. Independentemente da ferramenta que empregue para o autor HTML, se traballa directamente co código, engadirá comentarios en HTML como este:

  1. Engade a primeira parte da etiqueta de comentario HTML:
  2. Despois da peza inicial do comentario, escriba o texto que desexa que apareza para este comentario. É probable que isto sexa instrucións para o seu desenvolvedor ou noutro futuro. Por exemplo, se desexa indicar onde comeza ou remata unha determinada sección nunha páxina, pode usar un comentario para detallalo.
  3. Unha vez que o texto do teu comentario se complete, peche a etiqueta de comentario como esta: ->
  4. Entón, en total, o teu comentario terá un aspecto semellante:

A visualización de comentarios

Calquera comentario que engada ao seu código HTML aparecerá nese código cando alguén vexa a orixe da páxina web ou abra o HTML nun editor para realizar algúns cambios. Non obstante, ese texto de comentario non aparecerá no navegador web cando un visitante normal acceda ao sitio. A diferenza doutros elementos HTML, incluídos os parágrafos, títulos ou listas, que realmente impactan a páxina dentro deses navegadores, os comentarios son realmente "detrás das escenas" partes da páxina.

Comentarios para propósitos de probas

Debido a que os comentarios non aparecen nun navegador web, poden usarse para "desactivar" partes dunha páxina durante a proba ou o desenvolvemento da páxina. Se engade a parte de apertura dun comentario directamente antes da parte da súa páxina / código que quere ocultar e despois engade a parte de peche ao final do código (os comentarios HTML poden abarcar varias liñas, polo que pode abrir un comente a liña 50 da súa clave e pecha-la na liña 75 sen problemas), entón calquera elemento HTML que caia dentro dese comentario xa non se mostrará no navegador. Estarán no seu código, pero non afectarán a visualización da páxina. Se tes que probar unha páxina para ver se unha determinada sección está a causar problemas, etc., comentar que a área fóra é preferible para borralo. Con comentarios, se a sección do código en cuestión proba non ser o problema, pode eliminar facilmente as pezas de comentarios e ese código aparecerá de novo. Simplemente asegúrese de que estes comentarios que se usan para probar non o fan nos sitios web de produción.

Se non se debe mostrar unha área dunha páxina, queres eliminar o código e non só comentalo antes de iniciar ese sitio.

Un bo uso dos comentarios HTML durante o desenvolvemento é cando está a construír un sitio web sensible . Debido a que as distintas partes deste sitio cambiarán a súa aparencia en función dos diferentes tamaños de pantalla , incluídas algunhas áreas que non se poden mostrar en absoluto, o uso de comentarios para alternar seccións dunha páxina pode ser un truco rápido e sinxelo para usar durante o desenvolvemento.

En canto ao rendemento

Vin algúns profesionais da web que suxiren que os comentarios sexan eliminados de arquivos HTML e CSS para axustar o tamaño destes ficheiros e crear páxinas con máis carga. Aínda que estou de acordo en que as páxinas deben estar optimizadas para o rendemento e deben cargarse rapidamente, aínda hai un lugar para o uso intelixente de comentarios en código. Teña en conta que estes comentarios están destinados a facilitar o traballo nun sitio no futuro, sempre que non o deixe con comentarios engadidos a cada liña do seu código, a pequena cantidade de tamaño do ficheiro engadiuse a unha páxina debido a Os comentarios deben ser máis que aceptables.

Consellos para usar comentarios

Algunhas cousas para ser conscientes ou lembrar cando se usan comentarios HTML:

  1. Os comentarios poden ser varias liñas.
  2. Utiliza comentarios para documentar o desenvolvemento da túa páxina.
  3. Os comentarios poden al; así que documenta contido, filas de táboa ou columnas, seguimos os cambios ou o que queiras.
  4. Os comentarios que "desactivar" as áreas dun sitio non deberían facelo en produción a non ser que este cambio sexa temporal e que se reverte a curto prazo (como se a mensaxe de alarma se activase ou desact.