Co jsou komentáře HTML a jak se používají
aPři prohlížení webové stránky v prohlížeči se zobrazuje vizuální znázornění toho, co se tento software (webový prohlížeč) zobrazuje na základě kódu konkrétní webové stránky. Pokud si přejete zdrojový kód webové stránky, uvidíte dokument složený z různých prvků HTML, včetně odstavců, nadpisů, seznamů, odkazů, obrázků a dalších. Všechny tyto prvky vykresluje prohlížeč na obrazovce návštěvníka jako součást zobrazení webové stránky. Jedna věc, kterou můžete nalézt v kódu HTML, který není zobrazen na obrazovce osoby, jsou známé jako "komentáře HTML".
Co je komentář?
Komentář je řetězec kódu ve formátu HTML, XML nebo CSS, který prohlížeč nebo syntaktický analyzátor nevidí. Jednoduše je zapsán do kódu, který poskytuje informace o tomto kódu nebo jiné zpětné vazbě od vývojářů kódu.
Většina programovacích jazyků má komentáře, jsou běžně používána vývojářem kódu pro jeden nebo více než jeden z následujících důvodů:
- Popište a vysvětlete komplikovaný kód někomu, kdo na něm bude muset v budoucnu pracovat - včetně sebe! Mohou se vrátit na kód 3 nebo 6 po uplynutí 12 měsíců nebo později, a nezapamatují si, proč něco udělali určitým způsobem. Komentáře mohou pomoci odpovědět na jejich otázky a připomenout jim, kde byla jejich mysl při prvním vývoji této stránky.
- Uveďte podrobnosti o tom, kdy byl kód upraven nebo přezkoumán. To může být užitečné informace a působit poněkud jako vývojový protokol o tom, kdy byl web naposledy zpracován.
- Odstraňte části kódu, ale nechte je k dispozici pro pozdější použití. To se často děje během testování webu a ladění. Máte-li problém na webu a nejste si jisti, co je příčinou tohoto problému, můžete se k jednotlivým částem vyjádřit k jednotlivým částem a identifikovat problém a poté vyřešit problém, který máte.
- Chatujte s dalšími vývojáři pracujícími na tomto kódu. To se pravděpodobně děje během vývoje jako způsobu, jak sdílet detaily s ostatními pracujícími na kódu současně. Pokud jsou tyto komentáře čistě vývojovými konverzacemi, je nejlepším postupem je před jejich spuštěním odstranit z kódu.
Tradičně se komentáře v jazyce HTML používají téměř pro všechny prvky, od vysvětlení složitých tabulkových struktur až po informující poznámky o obsahu samotné stránky. Vzhledem k tomu, že komentáře nejsou v prohlížeči zobrazeny, můžete je přidat kdekoliv v kódu HTML a nemusíte se starat o to, co bude dělat, když je web zobrazen zákazníkem.
Jak psát komentáře
Psaní komentářů v HTML, XHTML a XML je velmi snadné. Jednoduše obklopte text, který chcete komentovat, pomocí následujícího:
a ->Jak vidíte, tyto komentáře začínají "méně než symbolem" a znaménkem a dvěma pomlčkami. Komentář končí dvěma dalšími pomlčkami a symbolem "větší než :. Mezi těmito znaky můžete psát, co chcete vytvořit z textu komentáře.
V CSS je to trochu jiné, a to pomocí kódů C kódu, spíše než pomocí HTML. Začněte s lomítkem dopředu a následnou hvězdičkou. Závěrečný komentář ukončíte, hvězdičkou následovanou lomítkem.
/ * komentovaný text * /Komentáře jsou umírající umění
Většina programátorů zná hodnotu užitečných komentářů . Komentovaný kód usnadňuje převedení tohoto kódu z jednoho člena týmu do druhého. Komentáře vám pomohou týmu QA otestovat kód, protože mohou říct, co vývojář zamýšlel - i když nebylo dosaženo. Bohužel, díky popularitě webových stránek pro tvorbu webových stránek, jako je Wordpress, které vám umožňují zvednout se a pracovat s vybraným tématem, který zpracovává hodně, ne-li všechny, HTML pro vás, komentáře nejsou využívány tak často webovými týmy. Je to proto, že komentáře jsou opravdu těžké vidět ve většině vizuálních nástrojů pro tvorbu obsahu, pokud nepracujete přímo s kódem. Například spíše než vidět v horní části webové stránky:
Vizuální nástroj zobrazuje malou ikonu, která označuje, že tam je komentář. Pokud návrhář fyzicky neotvírá komentář, možná ho nikdy neuvidí. A v případě výše uvedené stránky by mohly způsobit problémy, pokud upraví stránku a editace je přepsána skriptem uvedeným v komentáři.
Co může být provedeno?
- Napište smysluplné a užitečné komentáře. Neočekávejte, že ostatní lidé budou číst vaše komentáře, pokud jsou příliš dlouhé nebo neobsahují užitečné informace.
- Jako vývojář byste měli vždy zkontrolovat komentáře, které vidíte na stránce.
- Používejte nástroje poskytované programy pro tvorbu obsahu, které vám umožňují přidat komentáře.
- Pomocí správy obsahu můžete ovládat způsob úpravy stránek.
I když jste jediná osoba, která upravuje vaše webové stránky, mohou být užitečné komentáře. Pokud upravujete komplikovanou stránku pouze jednou za rok, je snadné zapomenout, jak jste postavili stůl nebo sestavili CSS. S připomínkami si nemusíte pamatovat, protože je to napsáno přímo pro vás.
Původní článek Jennifer Krynin. Upraveno Jeremy Girardem 5. 5. 17