Zahrnutí komentářů do kódu CSS je užitečné a vysoce doporučeno.
Každý web je tvořen strukturními prvky (které jsou diktovány HTML), stejně jako vizuální styl nebo "vzhled a dojem" tohoto webu. Kaskádové styly (CSS) jsou to, co se používá k diktování vizuálního vzhledu webových stránek. Tyto styly jsou odděleny od struktury HTML, což umožňuje snadnou aktualizaci a dodržování webových standardů.
S velikostí složitosti mnoha webů dnes se stylové listy mohou rychle stát poměrně zdlouhavým a velmi těžkopádným, s nímž můžete pracovat. To platí zejména, když začnete přidávat do mediálních dotazů odpovědi na styly webových stránek . Samotné dotazy o médiích mohou do dokumentu CSS přidávat značné množství nových stylů a dělat to ještě těžší. To je místo, kde se komentáře CSS mohou stát neocenitelnou pomocí na webových stránkách.
Přidání komentářů do souborů CSS webových stránek je skvělý způsob, jak přidat strukturu do částí tohoto kódu pro čtenáře, který kontroluje dokument. Je to také skvělá metoda pro vysvětlení těch stylů pro web profesionály, kteří budou muset v budoucnosti pracovat na webu - včetně sebe!
Nakonec, inteligentně přidané komentáře k CSS usnadní tvorbu stylu. To je skutečně důležité pro stylové listy, které budou editovány týmy. Poznámky mohou být použity k sdělování důležitých aspektů stylu listům různým členům týmu, kteří již s daným kódem nemuseli znát. Tyto komentáře mohou být také velmi užitečné pro lidi, kteří dříve pracovali na webu, pokud se dostanou zpět do kódu poté, co se na nějakou dobu odklonili. Často jsem musel upravovat webové stránky, které jsem postavil před měsíci nebo dokonce lety a mít dobře formátované komentáře v HTML a CSS je velmi vítaná pomoc! Pamatujte, že právě proto, že jste postavili stránky, neznamená, že si budete pamatovat, proč jste udělali to, co jste udělali, když se v budoucnu vrátíte na tento web! Komentáře mohou vaše záměry jasně vyjasnit a odstranit jakékoli nedorozumění, než se vůbec stane.
Jedna věc, která je pochopitelná pro komentáře CSS, je, že se nezobrazují, když se stránka vykreslí ve webových prohlížečích. Tyto komentáře jsou pouze informativní, stejně jako komentáře HTML (ačkoli syntaxe se liší od obou). Tyto komentáře CSS neovlivňují vizuální zobrazení webu žádným způsobem a jsou prostě přítomny v samotném kódu.
Přidání komentářů CSS
Přidání komentáře CSS je poměrně snadné. Jednoduše zaúčtujte svůj komentář se správnými značkami pro zahájení a ukončení komentářů:
- Začněte svůj komentář přidáním / *
- Zavřete svůj komentář přidáním * /
Všechno, co se objeví mezi těmito dvěma značkami, bude obsahem komentáře, který je viditelný pouze v kódu a prohlížečem není vykreslen.
Komentář CSS může mít jeden řádek nebo může obsahovat více řádků. Zde je příklad jednoho řádku:
div # border_red {okraj: tenké červené; } / * příklad červeného ohraničení * /A víceřádkový příklad:
/ *************************** ********************** ****** Styl pro kódový kód ******************************** ************* *************** /Rozdělit sekce
Jedním ze způsobů, kterými často používají komentáře CSS, je uspořádání mého stylu na menších, snadněji rozložitelných kusech. Líbí se mi, když tyto soubory prohlížím později. K tomu často přidávám komentáře se spoustou pomlčků, které v nich poskytují velké, zřejmé přestávky na stránce, které jsou snadno viditelné, když rychle procházím kódem. Zde je příklad:
/ * ----------------------- Styly hlavičky ----------------------- ------- * /Když vidím jeden z těchto komentářů v mém kódu, vím, že je to začátek nové části tohoto dokumentu, což mi umožňuje jednodušší zpracování a používání kódu.
Komentář & # 34; Kód
Značky komentářů mohou být užitečné i ve skutečném procesu kódování a ladění stránky. Komentáře mohou být použity k "komentování" nebo "vypnutí" oblastí tohoto kódu, aby se zjistilo, co se stane, pokud tato část není součástí stránky.
Jak to funguje? No, protože komentáře označují prohlížeč, aby ignoroval vše mezi nimi, můžete je použít k dočasnému vypnutí určitých částí kódu CSS. To může být užitečné při ladění nebo při úpravě formátování webové stránky.
Chcete-li to provést, jednoduše byste přidali značku otevření komentáře, kde chcete, aby kód začal být deaktivován, a potom umístěte koncovou značku tam, kde chcete ukončit zakázanou část. Všechno mezi těmito značkami neovlivní vizuální zobrazení webu, což vám umožní ladit CSS a zjistit, kde se může stát problém. Potom můžete jít a opravit právě tento problém a odstranit komentáře z kódu.
CSS komentáře tipů
Jako rekapitulace uvádíme několik tipů, které si můžete zapamatovat, pokud používáte komentáře ve vašem CSS:
- Komentáře mohou zahrnovat více řádků.
- Komentáře mohou obsahovat prvky CSS, které nechcete zobrazovat prohlížečem, ale nechcete je úplně odstranit. Jedná se o pěkný způsob, jak ladit webové stránky stylových listů - prostě nezapomeňte odstranit nepoužívané styly (na rozdíl od jejich nechání komentoval), pokud se rozhodnete, že je nepotřebujete na webových stránkách
- Používejte komentáře vždy, když píšete složité CSS, abyste přidali objasnění a informovali budoucí vývojáře nebo sebe v budoucnu o důležitých věcech, které by měli vědět. Tím ušetříte budoucí vývojový čas pro všechny zúčastněné strany.
- Komentáře mohou obsahovat také meta informace jako:
- autor
- datum vytvoření
- informace o autorských právech
Výkon
Komentáře mohou určitě být užitečné, ale uvědomte si, že čím více komentářů přidáte do listu stylů, tím hehtější bude, což ovlivní rychlost a výkon stahování webu. To je skutečný problém, ale neměli byste váhat přidávat užitečné a legitimní připomínky z obavy, že výkon bude trpět. Řádky CSS nepřidávají do dokumentu značnou velikost. Budete muset přidat TONS řádků komentářů, abyste měli významný dopad na velikost souboru CSS. Přidání hrstky užitečných komentářů do vašeho CSS by nemělo dát čistý negativní dopad na rychlost stránky.
Nakonec budete chtít najít rovnováhu mezi užitečnými komentáři a příliš mnoha komentáři, abyste získali výhody obou dokumentů v CSS.
Původní článek Jennifer Krynin. Upraveno Jeremy Girardem 7. 5. 17