Como inserir un comentario CSS

Incluír comentarios no teu código CSS é útil e moi recomendable.

Cada sitio web está composto por elementos estruturais (que son ditados por HTML), así como o estilo visual ou o "aspecto" deste sitio. As follas de estilo en cascada (CSS) son as que se usan para dictar a aparencia visual dun sitio web. Estes estilos mantéñense separados da estrutura HTML para permitir a facilidade de actualización e adherencia aos estándares web.

Co tamaño da complexidade de moitos sitios web hoxe, as follas de estilo poden rapidamente ser bastante longas e moi complicadas de traballar. Isto é especialmente certo cando comeza a engadir en consultas de medios para estilos de sitios de resposta . Estas consultas por medios só poden agregar unha cantidade significativa de novos estilos a un documento CSS e facer aínda máis difícil traballar. Aquí é onde os comentarios de CSS poden converterse nunha axuda inestimable nun sitio web.

Engadir comentarios aos ficheiros CSS dun sitio web é unha boa forma de engadir estrutura ás seccións dese código para un lector humano que está a revisar o documento. Tamén é un método marabilloso para explicar eses estilos para un profesional da web que poida ter que traballar no sitio no futuro, incluído ti mesmo.

Ao final, os comentarios CSS intelixentes engadiron unha folla de estilo máis doado de procesar. Este é, de feito, importante para follas de estilo que serán editadas por equipos. Os comentarios poden ser usados ​​para comunicar aspectos importantes da folla de estilo a diferentes membros do equipo que quizais non estean familiarizados co código. Estes comentarios tamén poden ser moi útiles para as persoas que traballaron no sitio antes de volver ao código despois de estar lonxe del durante algún tempo. Moitas veces tiven que editar un sitio web que construíi meses ou mesmo anos e ter comentarios ben formateados no HTML e CSS é unha axuda moi benvida. Teña en conta que, só porque construíches un sitio non significa que recordaras por que fixeches as cousas que fixeches ao volver a ese sitio no futuro. Os comentarios poden facer claras as túas intencións e aclarar calquera malentendido antes de que pase.

Unha cousa para comprender sobre os comentarios de CSS é que non se mostran cando a páxina fai navegadores web. Os comentarios son só informativos, así como os comentarios HTML (aínda que a sintaxe é diferente entre os dous). Estes comentarios CSS non afectan a visualización visual dun sitio de ningún xeito e simplemente están presentes no propio código.

Engadir comentarios CSS

Engadir un comentario CSS é bastante sinxelo. Simplemente publica o teu comentario coas etiquetas de comentario e apertura correctas:

Calquera cousa que apareza entre estas dúas etiquetas será o contido do comentario, visible só no código e non renderizado polo navegador.

Un comentario CSS pode ser unha única liña, ou pode ocupar varias liñas. Aquí tes un exemplo de liña única:

div # border_red {fronteira: fino vermello sólido; } / * exemplo de borde vermello * /

E un exemplo multilínea:

/ *************************** ********************** ****** Estilo para texto de código **************************** ************ *************** /

Seccións Breaking Out

Unha das formas en que a miúdo uso os comentarios de CSS é organizar a miña folla de estilo en anacos máis pequenos e máis fácilmente descoñecidos. Gustaríame poder ver facilmente estas seccións cando percibo o ficheiro máis tarde. Para iso, moitas veces engado comentarios con moitos guións neles para que proporcionen pausas grandes e obvias na páxina que son fáciles de ver a medida que avanza rapidamente o código. Aquí tes un exemplo:

/ * ----------------------- Estilos de encabezado ----------------------- ------- * /

Cando vexo un destes comentarios no meu código, sei que é o comezo dunha nova sección dese documento, o que me permite procesar e utilizar o código de forma máis sinxela.

& # 34; Commenting Out & # 34; Código

As etiquetas de comentarios tamén poden ser útiles no proceso real de codificación e depuración dunha páxina. Os comentarios poden ser usados ​​para "comentar" ou "desactivar" áreas deste código para ver que pasa se esa sección non forma parte da páxina.

Entón como funciona isto? Ben, porque as etiquetas de comentarios indican ao navegador que ignore todo entre elas, pode usalas para deshabilitar temporalmente certas partes do código CSS. Isto pode ser útil ao depurar ou ao axustar o formato da páxina web.

Para iso, simplemente engadirá a etiqueta de comentario de apertura na que desexa que o código se inicie e despois coloque esa etiqueta final na que desexa finalizar a parte desactivada. Todo entre esas etiquetas non afectará a visualización dun sitio, o que lle permite depurar o CSS para ver onde pode estar a suceder un problema. Podes entrar e solucionar só ese problema e eliminar os comentarios do código.

Consellos de comentario CSS

Como recapitulación, aquí tes algúns consellos para lembrar por usar comentarios no teu CSS:

  1. Os comentarios poden abarcar varias liñas.
  2. Os comentarios poden incluír elementos CSS que non desexes renderizar por un navegador, pero non desexas eliminar por completo. Este é un bo xeito de depurar as follas de estilo dun sitio web: simplemente asegúrate de eliminar os estilos non utilizados (en oposición a deixalos comentados) se decides que non os necesitas no sitio web
  3. Utiliza comentarios cada vez que escribes un CSS complicado para agregar aclaracións e informar aos futuros desenvolvedores ou ti mesmo no futuro sobre cousas importantes que deberían saber. Isto aforrará o tempo de desenvolvemento futuro para todos os implicados.
  4. Os comentarios tamén poden incluír información meta como:
    • autor
    • data creada
    • información de copyright

Rendemento

Os comentarios poden certamente ser útiles, pero teña en conta que canto máis comentarios engades nunha folla de estilo, o máis forte será o que afectará a velocidade de descarga e o rendemento dun sitio. Esta é unha preocupación real, pero non debes dubidar en engadir comentarios útiles e lexítimos por medo a que o desempeño sufrirá. As liñas de CSS non engaden tamaño substancial a un documento. Necesitaría engadir TONELADAS de liñas de comentarios para ter un impacto significativo no tamaño do ficheiro CSS. Engadir un puñado de comentarios útiles no teu CSS non debería darlle un impacto negativo neto na velocidade da páxina.

Ao final, quererá atopar o equilibrio entre comentarios útiles e moitos comentarios para obter os beneficios dos seus documentos CSS.

Artigo orixinal de Jennifer Krynin. Editado por Jeremy Girard o 17 de febreiro