Správne komentované HTML značenie je dôležitou súčasťou dobre zostavenej webovej stránky. Tieto komentáre sa dajú ľahko pridať a každý, kto v budúcnosti bude musieť pracovať na kóde tejto stránky (vrátane vás alebo členov tímu, s ktorým spolupracujete), vám za tieto komentáre poďakuje.
Ako pridať komentáre HTML
Na tvorbu HTML je možné použiť štandardný textový editor, napríklad Notepad ++ pre Windows alebo TextEdit pre Mac. Môžete tiež použiť program zameraný na webdizajn, ako je Adobe Dreamweaver, alebo dokonca platformu CMS, ako je Wordpress alebo ExpressionEngine. Bez ohľadu na nástroj, ktorý používate na tvorbu kódu HTML, ak pracujete priamo s kódom, pridali by ste komentáre HTML takto:
Pridajte prvú časť značky komentára HTML:
Po úvodnej časti komentára napíšte text, ktorý by sa mal pre tento komentár zobraziť. Pravdepodobne to budú v budúcnosti pokyny pre vášho alebo iného vývojára. Napríklad, ak chcete určiť, kde sa určitá časť stránky začína alebo končí v označení, môžete to podrobne uviesť pomocou komentára.
Po dokončení textu komentára zavrite značku komentára takto:
Celkovo teda bude váš komentár vyzerať asi takto:
Je to naozaj také jednoduché.
Zobrazenie komentárov
Všetky komentáre, ktoré pridáte do svojho kódu HTML, sa v tomto kóde objavia, keď niekto bude zobrazí zdroj webovej stránky alebo otvorí HTML v editore a urobí nejaké zmeny. Tento text komentára sa však vo webovom prehliadači nezobrazí, keď na stránku prídu normálni návštevníci. Na rozdiel od iných prvkov HTML, vrátane odsekov, nadpisov alebo zoznamov, ktoré skutočne ovplyvňujú stránku v týchto prehliadačoch, komentáre sú skutočne „zákulisnými“ časťami stránky.
Poznámky pre účely testovania
Pretože sa komentáre nezobrazujú vo webovom prehliadači, môžu sa použiť na „vypnutie“ častí stránky počas testovania alebo vývoja stránky. Ak pridáte úvodnú časť komentára priamo pred časť svojej stránky / kódu, ktorú chcete skryť, a potom pridáte záverečná časť na konci tohto kódu (komentáre HTML môžu obsahovať viac riadkov, takže môžete otvoriť komentár napríklad na riadku 50 vášho kódu a bez problémov ho zatvorte na riadku 75), potom sa v HTML už nebudú zobrazovať všetky prvky HTML, ktoré spadajú do tohto komentára prehliadač. Zostanú vo vašom kóde, ale nebudú mať vplyv na vizuálne zobrazenie stránky. Ak potrebujete otestovať stránku, aby ste zistili, či určitá časť nespôsobuje problémy atď., Je lepšie komentovať túto oblasť. Ak sa v komentároch ukáže, že problémová časť kódu nie je problém, môžete kúsky komentárov ľahko odstrániť a tento kód sa znova zobrazí. Len sa uistite, že tieto komentáre, ktoré sa používajú na testovanie, sa nedostanú do produkčných webov. Ak by sa časť stránky nemala zobraziť, chcete pred spustením tejto stránky odstrániť kód, nielen ho komentovať.
Jedno veľké využitie komentárov HTML počas vývoja je, keď staviate responzívny web. Pretože rôzne časti tohto webu budú meniť svoj vzhľad na základe rôzne veľkosti obrazovky, vrátane niektorých oblastí, ktoré sa nemusia vôbec zobraziť, použitie poznámok na zapínanie a vypínanie častí stránky môže byť rýchly a ľahký trik, ktorý sa dá použiť počas vývoja.
Pokiaľ ide o výkon
Videl som, ako niektorí weboví profesionáli navrhujú, aby sa zo súborov HTML a CSS odstraňovali komentáre, aby sa oholilo, aby sa zmenšila veľkosť 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 načítať rýchlo, stále existuje miesto pre inteligentné použitie komentárov v kóde. Pamätajte, že tieto komentáre majú uľahčiť prácu na webe v budúcnosti, pokiaľ to však s nimi nepreháňate. komentáre pridané ku každému riadku vášho kódu, malé množstvo veľkosti súboru pridaného na stránku kvôli komentárom by malo byť viac ako prijateľné.
Tipy na používanie komentárov
Pri používaní komentárov HTML je treba mať na pamäti alebo nezabudnúť:
- Komentáre môžu mať viac riadkov.
- Pomocou komentárov zdokumentujte vývoj svojej stránky.
- Komentáre môžu tiež dokumentovať obsah, riadky alebo stĺpce tabuľky, sledovať zmeny alebo čo chcete.
- Komentáre, ktoré „vypínajú“ oblasti webu, by sa nemali dostať do výroby, pokiaľ nejde o túto zmenu dočasná, ktorá bude v krátkom poradí vrátená späť (ako napríklad zapnutie alebo vypnutie výstražnej správy ako potrebné).