Ako vložiť komentár CSS

Zahrnutie komentárov do kódu CSS podporuje efektívny vývoj

pxhere.com / CC BY 0

Každá webová stránka sa skladá zo štrukturálnych, funkčných a štylistických prvkov. Kaskádové štýly diktovať vzhľad („vzhľad a dojem“) webovej stránky. Tieto štýly sú oddelené od štruktúry HTML, čo umožňuje jednoduchú aktualizáciu a dodržiavanie webových štandardov.

Problém so šablónami štýlov

Vzhľadom na veľkosť a zložitosť mnohých webových stránok dnes môžu byť šablóny štýlov dosť zdĺhavé a ťažkopádne. Tento problém teraz narástol na komplexnosti mediálne otázky pre responzívne štýly webu sú podstatnou súčasťou dizajnu a zabezpečujú, že webová lokalita vyzerá tak, ako má, bez ohľadu na zariadenie. Len tieto mediálne dopyty môžu do dokumentu CSS pridať značné množstvo nových štýlov, vďaka čomu je práca s nimi ešte ťažšia. Zvládnutie tejto zložitosti je miestom, kde sa komentáre CSS môžu stať neoceniteľnou pomocou pre dizajnérov a vývojárov webových stránok.

Komentáre Pridať štruktúru a prehľadnosť

Pridaním komentárov do súborov CSS webovej lokality sa zorganizujú sekcie tohto kódu pre čitateľa, ktorý dokument skontroluje. Zabezpečuje tiež konzistentnosť, keď jeden webový profesionál pokračuje tam, kde iný končí, alebo keď na stránke pracujú tímy ľudí.

Dobre naformátované komentáre oznamujú dôležité aspekty šablóny štýlov členom tímu, ktorí nemusia byť oboznámení s kódom. Tieto komentáre sú užitočné aj pre ľudí, ktorí na stránke už predtým pracovali, ale v poslednej dobe ešte nepracovali; webdizajnéri zvyčajne pracujú na mnohých stránkach a zapamätať si dizajnové stratégie z jednej na druhú je ťažké.

Len pre oči profesionálov

Komentáre CSS sa pri vykresľovaní stránky nezobrazujú webové prehliadače . Tieto komentáre sú len informatívne, rovnako ako HTML komentáre sú (aj keď syntax je iná). Tieto komentáre CSS žiadnym spôsobom neovplyvňujú vizuálne zobrazenie stránky.

Pridávanie komentárov CSS

Pridanie komentára CSS je celkom jednoduché. Zarezervujte svoj komentár pomocou správnych otváracích a zatváracích značiek komentárov:

Začnite svoj komentár pridaním /* a zatvorte ho */ .

Čokoľvek, čo sa objaví medzi týmito dvoma značkami, je obsahom komentára, ktorý je viditeľný iba v kóde a prehliadač ho nevykresľuje.

Komentár CSS môže zaberať ľubovoľný počet riadkov. Tu sú dva príklady:

|_+_|

Rozdelenie sekcií

Mnoho dizajnérov organizuje štýly do malých, ľahko stráviteľných kúskov, ktoré sa pri čítaní ľahko skenujú. Zvyčajne uvidíte komentáre, pred ktorými a za nimi nasledujú série pomlčiek, ktoré vytvárajú veľké, zreteľné prestávky na stránke, ktoré sú ľahko viditeľné. Tu je príklad:

|_+_|

Tieto komentáre označujú začiatok novej časti kódovania.

Kód na komentovanie

Pretože značky komentárov hovoria prehliadaču, aby ignoroval všetko medzi nimi, môžete ich použiť na dočasné vypnutie určitých častí kódu CSS. Tento trik môže byť užitočný pri ladení alebo pri úprave formátovania webovej stránky. V skutočnosti ich dizajnéri často používajú na „komentovanie“ alebo „vypnutie“ oblastí kódu, aby zistili, čo sa stane, ak daná sekcia nie je súčasťou stránky.

Pridajte úvodnú značku komentára pred kód, ktorý chcete komentovať (zakázať); umiestnite uzatváraciu značku tam, kde chcete, aby zakázaná časť skončila. Nič medzi týmito značkami neovplyvní vizuálne zobrazenie stránky, čo vám pomôže odladiť CSS, aby ste videli, kde sa vyskytuje problém. Potom môžete ísť dovnútra a opraviť len túto chybu a potom odstrániť komentáre z kódu.

CSS tipy na komentovanie

Mnoho kódovačov obsahuje bloky komentárov v hornej časti každého nového súboru s kódom. Napodobňujte túto stratégiu zahrnutím bloku komentárov s vaším menom, relevantnými dátumami a súvisiacimi informáciami, aby ste ľuďom pomohli pochopiť kontext projektu a nielen rozhodnutia o tom, čo sa stane v súvislosti s konkrétnym blokom kódu.