Jak přidat komentáře do vašeho HTML

Správně označená značka HTML je důležitou součástí dobře vytvořené webové stránky. Tyto připomínky se snadno přidávají a každý, kdo bude muset v budoucnu pracovat na kódu tohoto webu (včetně sebe nebo členů nějakého týmu, s nímž pracujete), vám za tyto připomínky poděkuje.

Jak přidat komentáře HTML

HTML lze vytvářet pomocí standardního textového editoru, například Notepad ++ pro Windows nebo TextEdit pro Ma. Můžete také využít program zaměřený na web design, jako je Adobe Dreamweaver nebo dokonce platforma CMS jako Wordpress nebo ExpressionEngine. Bez ohledu na nástroj, který používáte k tvorbě kódu HTML, pracujete přímo s kódem, můžete přidat komentáře ve formátu HTML takto:

  1. Přidejte první část značky HTML komentáře:
  2. Po této úvodní poznámce napište jakýkoli text, který byste chtěli pro tento komentář zobrazit. Pravděpodobně to bude v budoucnu instrukce pro vašeho nebo jiného vývojáře. Chcete-li například určit, kde určitá část stránky začíná nebo končí označením, můžete k jejímu upřesnění použít poznámku.
  3. Až bude text vašeho komentáře dokončen, zavřete značku poznámek takto: ->
  4. Celkově tedy váš komentář bude vypadat takto:

Zobrazení komentářů

Jakékoli poznámky, které přidáte do kódu HTML, se v tomto kódu zobrazí, když někdo prohlíží zdroj webové stránky nebo otevře HTML v editoru, aby provedl nějaké změny. Text komentáře se však ve webovém prohlížeči nezobrazí, když se běžní návštěvníci dostanou na web. Na rozdíl od jiných prvků HTML, včetně odstavců, nadpisů nebo seznamů, které skutečně ovlivňují stránku uvnitř těchto prohlížečů, jsou komentáře skutečně "za zákulisí".

Komentáře k účelům testování

Vzhledem k tomu, že se komentáře v prohlížeči nevyskytují, mohou být při testování nebo vývoji stránek použity k vypínání částí stránky. Pokud přidáte úvodní část komentáře přímo před částí stránky / kódu, kterou chcete skrýt, a potom přidáte uzavírací část na konci tohoto kódu (komentáře HTML mohou obsahovat více řádků, takže můžete otevřít komentujte řádek č. 50 svého kódu a zavřete jej bez problémů na řádku 75), pak se veškeré prvky HTML, které spadají do tohoto komentáře, již v prohlížeči nebudou zobrazovat. Zůstanou v 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 způsobuje potíže, atd., Je vhodné ji odstranit. S připomínkami, pokud se ukázalo, že příslušná část kódu není problémem, můžete jednoduše odstranit komentáře a tento kód se znovu zobrazí. Jen se ujistěte, že tyto komentáře, které se používají pro testování, neumožňují jejich zařazení do produkčních webových stránek.

Pokud by se oblast stránky neměla zobrazovat, před spuštěním tohoto webu jej chcete odstranit, nikoli pouze jej vyjádřit.

Jedním z velkých použití komentářů HTML během vývoje je, když budujete citlivé webové stránky . Vzhledem k tomu, že různé části tohoto webu změní svůj vzhled na základě různých velikostí obrazovky , včetně některých oblastí, které nemusí být vůbec zobrazeny, může být při vývoji používán rychlý a snadný trik používající komentáře k přepínání sekcí stránky.

Co se týče výkonu

Viděla jsem, že někteří weboví profesionálové navrhují, aby komentáře byly odstraněny ze souborů HTML a CSS, aby se oholily velikost těchto souborů a vytvořily stránky s rychlejším načtením. Přestože souhlasím s tím, že stránky by měly být optimalizovány pro výkon a měly by se rychle načíst, stále existuje místo pro chytré používání poznámek v kódu. Nezapomínejte, že tyto komentáře mají usnadnit práci na webu v budoucnu, takže pokud jej nezpracujete s komentáři přidanými ke každému řádku ve vašem kódu, malé množství velikosti souboru přidané na stránku kvůli komentáře by měly být více než přijatelné.

Tipy pro použití poznámek

Několik věcí, které si musíte pamatovat nebo pamatovat při používání komentářů HTML:

  1. Komentáře mohou obsahovat více řádků.
  2. Pomocí poznámek můžete dokumentovat vývoj vaší stránky.
  3. Komentáře mohou být; tak obsah dokumentu, řádky tabulky nebo sloupce, změny stop nebo cokoli chcete.
  4. Komentář, že by oblasti "vypnutí" webu neměly být uvedeny do výroby, pokud tato změna není dočasná, která bude v krátké době obrácena (jako třeba zapnutí nebo vypnutí výstražné zprávy podle potřeby).