Správne komentované značenie HTML je dôležitou súčasťou dobre vybudovanej webovej stránky. Tieto pripomienky sa ľahko pridávajú a každý, kto bude musieť v budúcnosti pracovať na kóde tejto stránky (vrátane vás alebo členov tímu, s ktorým pracujete) vám poďakuje za tieto pripomienky.
Ako pridať HTML komentáre
HTML môže byť vytvorený pomocou štandardného textového editora, napríklad Notepad ++ pre Windows alebo TextEdit pre Ma. Môžete tiež použiť program zameraný na web design, ako je Adobe Dreamweaver alebo dokonca CMS platforma ako Wordpress alebo ExpressionEngine. Bez ohľadu na nástroj, ktorý používate na tvorbu kódu HTML, ak pracujete priamo s kódom, pridáte HTML komentáre, ako napríklad:
- Pridajte prvú časť značky HTML komentára:
- Po úvodnej časti komentára napíšte text, ktorý chcete zobraziť pre túto poznámku. Pravdepodobne to bude v budúcnosti inštrukcie pre vášho alebo iného vývojára. Ak napríklad chcete určiť, kde určitá časť na stránke začína alebo končí označením, môžete na to podrobnejšie použiť komentár.
- Akonáhle bude text vašej poznámky dokončený, zatvorte komentár ako takto: ->
- Takže celkom váš komentár bude vyzerať takto:
Zobrazenie komentárov
Všetky komentáre, ktoré pridáte do kódu HTML, sa v tomto kóde objavia, keď niekto zobrazí zdroj webovej stránky alebo otvorí HTML v editore, aby vykonal nejaké zmeny. Text komentára sa však vo webovom prehliadači neobjaví, keď sa návštevníci dostanú na stránku. Na rozdiel od iných prvkov HTML vrátane odsekov, nadpisov alebo zoznamov, ktoré skutočne ovplyvňujú stránku vo vnútri týchto prehliadačov, sú komentáre skutočne "za zákulisím" častí stránky.
Komentáre na účely testovania
Keďže komentáre sa nezobrazujú vo webovom prehliadači, môžu sa počas testovania stránok alebo vývoja použiť na vypnutie častí stránky. Ak pridáte úvodnú časť komentára priamo pred časťou vašej stránky / kódu, ktorú chcete skryť, a potom pridajte záverečnú časť na konci tohto kódu (komentáre HTML môžu obsahovať viac riadkov, takže môžete otvoriť komentár na riadku 50 vášho kódu a zatvorenie na riadku 75 bez problémov), potom akékoľvek prvky HTML, ktoré spadajú do tejto poznámky, už nebudú zobrazené v prehliadači. Zostanú v kóde, ale nemajú vplyv na vizuálne zobrazenie stránky. Ak potrebujete vyskúšať stránku a zistiť, či určitá časť spôsobuje problémy, atď., Uprednostňujete jej odstránením. S komentármi sa v prípade, že daná časť kódu preukáže, že nie je problém, môžete ľahko odstrániť kúsky komentárov a tento kód sa znova zobrazí. Stačí sa ubezpečiť, že tieto komentáre, ktoré sa používajú na testovanie, nerobia na výrobné webové stránky.
Ak by sa oblasť stránky nemala zobrazovať, pred spustením tejto stránky chcete odstrániť kód, nielen ho komentovať.
Veľké využitie komentárov HTML počas vývoja je pri budovaní citlivej webovej stránky . Vzhľadom k tomu, že rôzne časti tejto stránky sa zmenia svoj vzhľad na základe rôznych veľkostí obrazovky , vrátane niektorých oblastí, ktoré sa nemusia zobrazovať vôbec, pomocou komentárov pre prepínanie sekcií stránky zapnuté alebo vypnuté môže byť rýchly a jednoduchý trik použiť počas vývoja.
Pokiaľ ide o výkon
Videl som niekoľko profesionálov na webe, ktorí navrhujú, aby boli komentáre odstránené z súborov HTML a CSS, aby sa ohnali veľkosti týchto súborov a vytvorili stránky s rýchlejším načítaním. Aj keď súhlasím s tým, že stránky by mali byť optimalizované pre výkon a mali by sa rýchlo načítať, stále existuje miesto pre inteligentné používanie komentárov v kóde. Nezabudnite, že tieto komentáre majú za cieľ uľahčiť prácu na webových stránkach v budúcnosti, tak dlho, kým ho nebudete zaplatiť pridaním komentárov ku každému riadku vo vašom kóde, malá veľkosť veľkosti súboru pridaná k stránke kvôli pripomienky by mali byť viac ako prijateľné.
Tipy na používanie komentárov
Niekoľko vecí, ktoré si musíte pamätať alebo pamätať pri používaní komentárov HTML:
- Komentáre môžu byť viaceré riadky.
- Pomocou pripomienok dokumentujte vývoj svojej stránky.
- Komentáre môžu byť; tak obsah dokumentu, riadky tabuľky alebo stĺpce, sledovanie zmien alebo čokoľvek by ste chceli.
- Pripomienky, ktoré "vypínajú" oblasti webu, by sa nemali zaradiť do výroby, pokiaľ táto zmena nie je dočasná, ktorá sa v krátkej dobe zruší (napríklad keď je podľa potreby zapnutá alebo vypnutá výstražná správa).