Správně komentováno HTML značka je důležitou součástí dobře sestavené webové stránky. Tyto komentáře lze snadno přidat a každý, kdo v budoucnu bude muset na kódu tohoto webu pracovat (včetně vás nebo členů týmu, se kterým pracujete), vám za tyto komentáře poděkuje.
Jak přidat komentáře HTML
HTML lze vytvářet pomocí standardního textového editoru, jako je Poznámkový blok ++ pro Windows nebo TextEdit pro Mac. Můžete také použít program zaměřený na webový design, jako je Adobe Dreamweaver, nebo dokonce platformu CMS, jako je Wordpress nebo ExpressionEngine. Bez ohledu na nástroj, který používáte k vytváření HTML, pokud pracujete přímo s kódem, přidali byste komentáře HTML takto:
Přidejte první část značky komentáře HTML:
Po této úvodní části komentáře napište text, který chcete pro tento komentář zobrazit. Pravděpodobně to budou v budoucnu pokyny pro vašeho nebo jiného vývojáře. Chcete-li například určit, kde určitá část na stránce začíná nebo končí ve značkování, můžete použít podrobný popis.
Jakmile je text vašeho komentáře kompletní, zavřete značku komentáře takto:
Celkově tedy váš komentář bude vypadat asi takto:
Je to opravdu tak jednoduché.
Zobrazení komentářů
Veškeré komentáře, které přidáte do svého kódu HTML, se v tomto kódu objeví, když někdo zobrazí zdroj webové stránky nebo otevře HTML v editoru a provede nějaké změny. Tento text komentáře se však ve webovém prohlížeči nezobrazí, když na web přijdou běžní návštěvníci. Na rozdíl od jiných prvků HTML, včetně odstavců, nadpisů nebo seznamů, které ve skutečnosti ovlivňují stránku uvnitř těchto prohlížečů, jsou komentáře skutečně „zákulisí“ části stránky.
Komentáře pro účely testování
Protože se komentáře nezobrazují ve webovém prohlížeči, lze je použít k „vypnutí“ částí stránky během testování nebo vývoje stránky. Pokud přidáte úvodní část komentáře přímo před část své stránky / kódu, kterou chcete skrýt, a poté přidáte závěrečná část na konci tohoto kódu (komentáře HTML mohou zahrnovat více řádků, takže můžete otevřít komentář na říkajícím řádku 50 vašeho kódu a zavřete jej na řádku 75 bez problémů), pak se v HTML již nebudou zobrazovat jakékoli prvky HTML, které spadají do tohoto komentáře prohlížeč. Zůstanou ve vašem kódu, ale nebudou mít vliv na vizuální zobrazení stránky. Pokud potřebujete otestovat stránku, abyste zjistili, zda určitá část nezpůsobuje problémy atd., Je lepší ji před odstraněním okomentovat. Pokud se u komentářů ukáže, že dotyčná část kódu není problém, můžete snadno odebrat části komentářů a tento kód se znovu zobrazí. Jen se ujistěte, že tyto komentáře, které se používají k testování, se nedostanou do produkčních webů. Pokud by se oblast stránky neměla zobrazovat, chcete kód před spuštěním webu odstranit, nejen jej okomentovat.
Jedno skvělé využití komentářů HTML během vývoje je, když stavíte responzivní web. Protože různé části tohoto webu změní svůj vzhled na základě různé velikosti obrazovky, včetně některých oblastí, které se nemusí vůbec zobrazit, může být použití rychlého a snadného triku během vývoje pomocí komentářů k přepínání nebo zapínání částí stránky.
Pokud jde o výkon
Viděl jsem, jak někteří weboví profesionálové navrhují, aby byly komentáře odstraněny ze souborů HTML a CSS, aby se oholilo, aby se zmenšila velikost těchto souborů a vytvořily se stránky s rychlejším načítáním. I když souhlasím s tím, že stránky by měly být optimalizováno pro výkon a měl by se načíst rychle, stále existuje místo pro chytré použití komentářů v kódu. Nezapomeňte, že tyto komentáře mají usnadnit budoucí práci na webu, takže pokud to nepřehánějte komentáře přidané ke každému řádku v kódu, malé množství velikosti souboru přidané na stránku kvůli komentářům by mělo být více než přijatelný.
Tipy pro používání komentářů
Při používání komentářů HTML je třeba mít na paměti nebo si pamatovat:
- Komentáře mohou mít více řádků.
- Pomocí komentářů zdokumentujte vývoj své stránky.
- Komentáře mohou také dokumentovat obsah, řádky nebo sloupce tabulky, sledovat změny nebo cokoli chcete.
- Komentáře, které „vypnou“ oblasti webu, by se neměly dostat do produkce, pokud tato změna není a dočasný, který bude v krátkém pořadí obrácen (jako například zapnutí nebo vypnutí výstražné zprávy jako potřeboval).