Megfelelően kommentálva HTML A jelölés a jól felépített weboldal fontos része. Ezeket a megjegyzéseket könnyen hozzá lehet adni, és bárki, akinek a jövőben az adott webhely kódján kell dolgoznia (beleértve önmagát vagy bármely olyan csapat tagját, akivel dolgozik), megköszöni ezeket a megjegyzéseket.
HTML-megjegyzések hozzáadása
A HTML szabványos szövegszerkesztővel írható, például a Notepad ++ for Windows vagy a TextEdit for Mac. Használhat olyan webdesign-központú programokat is, mint az Adobe Dreamweaver, vagy akár egy CMS-platformot, például a Wordpress vagy az ExpressionEngine. Függetlenül a HTML készítéséhez használt eszköztől, ha közvetlenül a kóddal dolgozik, akkor ehhez hasonló HTML-megjegyzéseket adjon hozzá:
Adja hozzá a HTML megjegyzés címke első részét:
A megjegyzés kezdő része után írjon be bármilyen szöveget, amelyet meg szeretne jeleníteni ehhez a megjegyzéshez. Ez valószínűleg a jövőben útmutatást nyújt Önnek vagy más fejlesztőnek. Például, ha meg akarja jelölni, hogy az oldal egy bizonyos része hol kezdődik vagy ér véget a jelöléssel, akkor ezt megjegyzéssel használhatja.
Miután a megjegyzés szövege elkészült, zárja be a megjegyzést a következőképpen:
Tehát a megjegyzésed így néz ki:
Ez tényleg ilyen egyszerű.
Megjegyzések megjelenítése
A HTML-kódhoz adott megjegyzések megjelennek abban a kódban, amikor valaki megtekintheti a weboldal forrását vagy megnyitja a HTML-t egy szerkesztőben néhány változtatás elvégzéséhez. Ez a megjegyzésszöveg azonban nem jelenik meg a webböngészőben, amikor normál látogatók érkeznek az oldalra. A HTML-elemektől eltérően, ideértve a bekezdéseket, fejléceket vagy listákat, amelyek ténylegesen befolyásolják az adott böngészőben lévő oldalt, a megjegyzések valóban az oldal "kulisszái mögött" vannak.
Megjegyzések tesztelési célokra
Mivel a megjegyzések nem jelennek meg egy webböngészőben, felhasználhatók az oldal egyes részeinek "kikapcsolására" az oldal tesztelése vagy fejlesztése során. Ha egy megjegyzés nyitó részét közvetlenül az oldal / kód elrejteni kívánt része elé helyezi, majd hozzáadja a záró rész a kód végén (a HTML megjegyzések több sorra is kiterjedhetnek, így megnyithat egy megjegyzést a kód mondjuk 50. sorához, és zárja be a 75-ös sorra problémamentesen), akkor az adott megjegyzésbe tartozó HTML elemek már nem jelennek meg a böngésző. A kódban maradnak, de nem befolyásolják az oldal vizuális megjelenítését. Ha tesztelnie kell egy oldalt, hogy bizonyos szakaszok problémákat okoznak-e, stb., Akkor inkább törölni kell a terület megjegyzését. Megjegyzésekkel, ha bebizonyosodik, hogy a kérdéses kódrész nem a kérdés, könnyen eltávolíthatja a megjegyzésdarabokat, és ez a kód ismét megjelenik. Csak győződjön meg arról, hogy ezek a teszteléshez használt megjegyzések nem jutnak el a termelési webhelyekre. Ha egy oldal nem jelenik meg, akkor a webhely indítása előtt el kell távolítania a kódot, és nem csak megjegyzést kell fűznie hozzá.
A HTML-megjegyzések egyik nagyszerű használata a fejlesztés során, amikor építesz egy érzékeny webhely. Mivel a webhely különböző részei az alapján megváltoztatják a megjelenésüket különböző képernyőméretek, beleértve azokat a területeket, amelyek esetleg egyáltalán nem jelennek meg, a megjegyzések használata az oldal szakaszainak be- vagy kikapcsolásához gyors és egyszerű trükk lehet a fejlesztés során.
Ami a teljesítményt illeti
Láttam, hogy néhány internetes szakember azt javasolja, hogy a megjegyzéseket töröljék a HTML- és CSS-fájlokról annak érdekében, hogy borotválják a fájlok méretét, és gyorsabban betöltődő oldalakat hozzanak létre. Bár egyetértek azzal, hogy az oldalak legyenek teljesítményre optimalizált és gyorsan be kell töltenie, még mindig van hely a megjegyzések intelligens használatára a kódban. Ne feledje, hogy ezek a megjegyzések arra szolgálnak, hogy megkönnyítsék a jövőben a webhelyen való munkát, mindaddig, amíg nem teszik túlzásba a kód minden sorához hozzáadott megjegyzés, az oldalhoz a megjegyzések miatt hozzáadott kis fájlméretnek többnek kell lennie elfogadható.
Tippek a megjegyzések használatához
Néhány dolog, amelyre érdemes figyelni vagy emlékezni a HTML-megjegyzések használatakor:
- A megjegyzések többsorosak lehetnek.
- A megjegyzések segítségével dokumentálhatja az oldal fejlődését.
- A megjegyzések dokumentálhatják a tartalmat, a táblázatsorokat vagy -oszlopokat, nyomon követhetik a változásokat vagy bármit, amit csak akarnak.
- Azok a megjegyzések, amelyek "kikapcsolják" a webhely területeit, csak akkor hozhatják létre a termelést, ha ez a változás a ideiglenes, amely rövid időn belül megfordul (például riasztási üzenet be- vagy kikapcsolása szükséges).