Amikor egy böngészőben megtekinti a weboldalt, vizuálisan megmutatja, hogy az adott szoftver (a webböngésző) hogyan jelenik meg egy adott weboldal kódja alapján. Ha megtekinti a weblap forráskódját, megjelenik egy dokumentum, amely különböző HTML elemekből áll, beleértve a bekezdéseket, címeket, listákat, linkeket, képeket és egyebeket. Mindezeket az elemeket a böngésző teszi a látogató képernyőjén a weboldal megjelenítésének részeként. Az egyik dolog, amit a HTML-kódban találsz, amely nem jelenik meg egy személy képernyőjén, az úgynevezett "HTML megjegyzések".
Mi a megjegyzés?
A megjegyzés a HTML, az XML vagy a CSS kódszáma, amelyet a böngésző vagy az értelmezők nem tekinthetnek meg, illetve nem vesznek részt. Egyszerűen beírja a kódot, hogy információt szolgáltasson erről a kódról vagy más visszajelzésről a kódfejlesztőkről.
A legtöbb programozási nyelvnek megjegyzései vannak, ezeket gyakran használják a kód fejlesztője egy vagy többnél, az alábbi okok miatt:
- Bontsa ki és magyarázza meg a bonyolult kódot valakinek, aki esetleg dolgozni kell a jövőben - beleértve magukat is! Visszajönnek a 12. vagy a 3. kódra, vagy a későbbiekben 12 hónapra, és nem emlékeznek arra, hogy miért tettek valamit bizonyos módon. A megjegyzések segítséget nyújthatnak a kérdések megválaszolásához, és emlékeztessék őket arra, hogy hol vannak az elméjük, amikor először fejlesztették ki az adott oldalt.
- Adjon meg részleteket a kód szerkesztéséről vagy felülvizsgálatáról. Ez hasznos információ lehet és valamilyen módon működik, mint egy fejlesztési napló, amikor egy webhelyet utoljára dolgoztunk.
- Távolítsa el a kód szakaszait, de hagyja őket későbbi használatra. Ezt gyakran a helyszíni tesztelés és a hibakeresés során végzik el. Ha problémája van egy webhelyen, és nem biztos benne, hogy mi okozza, akkor az egyes szakaszokat megjegyzést teheti a karanténba és azonosítani tudja a problémát, majd dolgozzon ki egy javítást bármilyen probléma esetén.
- Csevegjen a kóddal dolgozó más fejlesztőkkel. Ez valószínűleg a fejlesztés során is megtörténik, mivel módja annak, hogy részleteket osszanak meg a kóddal dolgozó másokkal egyidejűleg. Ha ezek a megjegyzések tisztán fejlesztési beszélgetések, akkor a legjobb gyakorlat, ha eltávolítja őket a kódról, mielőtt egy webhely elindulna.
Hagyományosan a HTML-ben szereplő megjegyzéseket szinte minden elemhez használják, a komplex struktúrák magyarázataként az oldal tartalmának tájékoztató megjegyzéseihez. Mivel a megjegyzéseket nem teszik közzé a böngészőben, hozzáadhatja őket bárhová a HTML-ben, és nem gondolja, hogy mit fog tenni, ha a webhelyet az ügyfél látja.
Hozzászólások írása
A HTML, XHTML és XML megjegyzések írása nagyon egyszerű. Egyszerűen körülveszi a megcélzott szöveget a következőkkel:
és
Amint láthatja, ezek a megjegyzések "kisebb mint szimbólummal" kezdődnek, felkiáltójel és két kötőjel. A megjegyzés két további kötőjellel és egy "nagyobb, mint: szimbólummal fejeződik be.
A CSS-ben ez egy kicsit más, a HTML kód helyett a C-kód megjegyzéseit használva. Előre vágott perjelvel kezdődik, majd egy csillaggal. A megjegyzést a fordítottjaival zárja, egy csillagot, majd egy előremutató perjelet.
A megjegyzések Dying Art
A legtöbb programozó ismeri a hasznos megjegyzések értékét. A megjegyzett kód megkönnyíti a kód átvitelét egy csapat tagból a másikba. A megjegyzések segítenek a QA csapatnak tesztelni a kódot, mert meg tudják mondani, hogy mit tervezett a fejlesztő - még akkor is, ha nem érte el. Sajnos, a webes megjelenítői platformok - például a Wordpress - népszerűsége miatt, amelyek lehetővé teszik számodra, hogy egy olyan kiválasztott témával álljunk fel és fussunk le, amely sok, ha nem mindegyiket a HTML-ben kezeli, a webes csapatok gyakran nem használják meg észrevételeiket. Ez azért van, mert a legtöbb vizuális íróeszközön nagyon nehéz megjegyezni, ha nem közvetlenül dolgozik a kóddal. Például, nem pedig a weboldal tetején:
A vizuális eszköz egy apró ikont mutat, amely jelzi, hogy van egy megjegyzés. Ha a tervező nem fizikailag megnyitja a megjegyzést, akkor soha nem látja. És a fenti oldal esetén problémákat okozhat, ha szerkeszteni fogja az oldalt, és a szerkesztésben túl van írva a megjegyzésben említett szkript.
Mit lehet tenni?
- Írj értelmes és hasznos megjegyzéseket. Ne várják másoktól, hogy olvassák meg észrevételeiket, ha túl hosszúak vagy nem tartalmaznak hasznos információkat.
- Mint fejlesztõ, meg kell mindig nézze meg az oldalakon megjelenő megjegyzéseket.
- Használja a szerzői programok által biztosított eszközöket, amelyek lehetővé teszik a megjegyzések hozzáadását.
- A tartalomkezelés segítségével szabályozhatja az oldal szerkesztését.
Még akkor is, ha te vagy az egyetlen, aki módosítja a weboldalakat, hasznosak lehetnek a megjegyzések. Ha egy bonyolult oldalt évente egyszer szerkesztesz, akkor könnyű elfelejteni, hogyan építetted fel az asztalt vagy összeraktad a CSS-t. Megjegyzésekkel nem kell emlékezni, mivel az ott írták.
