Jak komentovat části kódu v (X)HTML ví snad každý webdesigner. Jestli to ale dělá každý bez chyb, je otázkou. I sebejednodušší činnosti mohou způsobit problémy. A právě remování mě nachytalo na hruškách nedávno.
Doporučení HTML 4.01 říká o komentářích zhruba toto: Mezi znaky a znaky -- nesmí být žádné whitespace znaky (mj. žádné mezery), ale tyto whitespace znaky jsou povoleny mezi ukončovacími znaky -- a ukončovacím znakem >. Častou chybou je vložení dvou a více znaků - uvnitř komentáře.
Prohlížeče
Můj obvyklý způsob zapisování kódu zahrnuje i poměrně časté psaní poznámek (viz testovací stránka). Věřte mi, je to užitečné. Často mám poznámku na začátku i konci poznámkou označeného bloku. A tady začíná můj problém, který mě potkal tento týden. Firefox mi na jedné stránce odkryl komentářem skrytou část stránky včetně části komentáře. Asi je Vám jasné, kde byl zakopaný pes.
Abych si ušetřil práci (zrovna jsem machroval a ukazoval, jak rychle můžu skrýt část stránky), tak jsem na konci úvodního komentáře smazal ony dvě pomlčky. Editor poslušně přebarvil blok do zelena a Internet Explorer 6 zamýšlenou část stránky skryl. Vymalováno. Ovšem jen do doby, než jsem si stránku prohlédl ve Firefoxu. Firefox se snaží ctít doporučení a zobrazí text, který následuje za uvodními znaky poznámky - tj. za a to včetně textu poznámky.
Opera se chová stejně jako IE - nebere v úvahu špatně napsanou poznámku a vše skryje.
Editory
Zajímavé taky je, jak se ke špatně zapsanému kódu poznámky staví editory:
- Adobe GoLive 6
- Kód označí jako celý zaremovaný. Chová se tak, jak IE zobrazuje.
- Macromedia Dreamweaver
- Kód označí jako celý zaremovaný. Chová se tak, jak IE zobrazuje.
- Macromedia Homesite 5
- Text označí jako zaremovaný až do výskytu ukončovacího sekvence
-->. V uvedeném příkladu to bylo až do konce HTML dokumentu.
- Microsoft FrontPage 2003
- Kód označí jako celý zaremovaný. Chová se tak, jak IE zobrazuje.
- NVU 0.3
- Celkem pochopitelně zobrazuje jako Firefox a do zdrojového kódu doplní(!) za začátek první poznámky dvě pomlčky (znaky mínus).
Vyzkoušel jsem ještě další editory. A všechny se chovaly tak, jak IE a Opera zobrazovaly a stejně jako FrontPage a spol. zobrazovaly. Testem prošel ještě editor 1st Page 2000, PSPad a TopStyle Pro 3.10.