Čo sú komentáre HTML a ako sa používajú
aPokiaľ zobrazíte webovú stránku v prehliadači, vidíte vizuálne zobrazenie toho, čo sa tento softvér (webový prehliadač) zobrazuje na základe kódu konkrétnej webovej stránky. Ak si prezriete zdrojový kód webovej stránky, uvidíte dokument pozostávajúci z rôznych prvkov HTML, vrátane odsekov, nadpisov, zoznamov, odkazov, obrázkov a ďalších. Všetky tieto prvky vykresľuje prehliadač na obrazovke návštevníka ako súčasť zobrazenia webovej stránky. Jedna vec, ktorú možno nájsť v HTML kóde, ktorý nie je vykreslený na obrazovke osoby, sú tie, ktoré sú známe ako "komentáre HTML".
Čo je to komentár?
Komentár je reťazec kódu v jazyku HTML, XML alebo CSS, ktorý prehľadávač alebo syntaktický analyzátor nevidí. Je to jednoducho zapísané do kódu, ktorý poskytuje informácie o tomto kóde alebo inej spätnej väzbe od vývojárov kódu.
Väčšina programovacích jazykov má pripomienky, ktoré používatelia kódu bežne používajú pre jedného alebo dokonca viac ako jeden z nasledujúcich dôvodov:
- Popíšte a vysvetlite komplikovaný kód niekomu, kto bude musieť v budúcnosti pracovať - vrátane seba! Môžu sa vrátiť späť na kód 3 alebo 6 po 12 mesiacoch alebo aj neskôr a nepamätáte si, prečo niečo urobili určitým spôsobom. Komentáre môžu pomôcť odpovedať na ich otázky a pripomenúť im, kde ich myseľ bola pri prvom vývoji tejto stránky.
- Uveďte podrobnosti o tom, kedy bol kód upravený alebo preskúmaný. To môže byť užitočné informácie a konať trochu ako vývojový denník, kedy bol web naposledy pracovať.
- Odstráňte časti kódu, ale ponechajte ich k dispozícii na neskoršie použitie. Často sa to robí počas testovania a ladenia stránok. Ak máte problém na stránkach a nie ste si istí, čo to spôsobuje, môžete komentovať sekcie jeden po druhom k quarentine a identifikovať problém, a potom pracovať na opravu, akékoľvek problémy, ktoré máte.
- Rozprávajte sa s ďalšími vývojármi, ktorí pracujú na kóde. Toto by sa pravdepodobne uskutočnilo počas vývoja ako spôsob zdieľania podrobností s ostatnými, ktorí pracujú na kóde zároveň. Ak sú tieto pripomienky čisto rozhovorom o vývoji, je najlepšou praxou odstrániť ich z kódu skôr, než sa spustí web.
Tradične sú komentáre v jazyku HTML použité pre takmer všetky prvky, od vysvetlení zložitých tabuľkových štruktúr až po informatívne poznámky o obsahu samotnej stránky. Keďže v prehliadači nie sú komentáre vykreslené, môžete ich pridať kdekoľvek v jazyku HTML a nemusíte sa obávať, čo bude robiť, keď sa stránka zobrazí zákazníkom.
Ako písať komentáre
Písanie komentárov v HTML, XHTML a XML je veľmi jednoduché. Jednoducho obklopte text, ktorý chcete komentovať, nasledovne:
a ->Ako môžete vidieť, tieto komentáre začínajú "menej ako symbolom", plus výkričníkom a dvomi pomlčkami. Komentár končí dvoma ďalšími pomlčkami a symbolom "viac ako:" Medzi týmito znakmi môžete napísať čokoľvek, čo chcete vytvoriť telo komentára.
V systéme CSS je to trochu iné, a to pomocou komentárov kódu C, a nie ako HTML. Začína sa lomítkom dopredu, za ktorým nasleduje hviezdička. Svoj komentár ukončíte inverzným spôsobom, hviezdičkou za ním nasleduje lomka.
/ * komentovaný text * /Komentáre sú umierajúce umenie
Väčšina programátorov pozná hodnotu užitočných komentárov . Komentovaný kód uľahčuje prenos tohto kódu z jedného člena tímu do druhého. Komentáre vám pomôžu tímu QA otestovať kód, pretože vie, čo chce vývojár určiť - aj keď to nebolo dosiahnuté. Bohužiaľ, s popularitou webových stránok na tvorbu webových stránok, ako je Wordpress, ktoré vám umožňujú dostať sa do prevádzky s vybranou témou, ktorá sa zaoberá mnohými, ak nie všetkými, z HTML pre vás, komentáre sa nepoužívajú tak často webovými tímami. Je to preto, že komentáre sú naozaj ťažké vidieť vo väčšine vizuálnych nástrojov na tvorbu obsahu, ak nepracujete priamo s kódom. Napríklad skôr ako vidieť, v hornej časti webovej stránky:
Vizuálny nástroj zobrazuje malú ikonu, ktorá označuje, že tam je komentár. Ak návrhár fyzicky neotvorí komentár, nemusí to nikdy vidieť. A v prípade vyššie uvedenej stránky by mohli spôsobiť problémy, ak edituje stránku a editácia je prepisovaná skriptom uvedeným v komentári.
Čo možno urobiť?
- Napíšte zmysluplné a užitočné komentáre. Neočakávajte, že ostatní ľudia budú čítať vaše komentáre, ak sú príliš dlhé alebo nezahŕňajú užitočné informácie.
- Ako vývojár by ste mali vždy skontrolovať všetky komentáre, ktoré vidíte na stránke.
- Používajte nástroje poskytované programami na tvorbu obsahu, ktoré vám umožňujú pridávať komentáre.
- Pomocou správy obsahu môžete ovládať spôsob úpravy stránok.
Dokonca aj keď ste jediná osoba, ktorá upravuje vaše webové stránky, môžu byť užitočné komentáre. Ak upravujete komplikovanú stránku len raz ročne, je ľahké zabudnúť na to, ako ste postavili stôl alebo vytvorili CSS. S pripomienkami si nemusíte pamätať, pretože je tu napísané práve pre vás.
Originálny článok od Jennifer Krynin. Upravený Jeremy Girard dňa 5/5/17