A FreeBSD Dokumentációs Projekt irányelvei kezdőknek
Előző | Fejezet 3. SGML alapismeretek | Következő

# 3.5. Megjegyzések

A megjegyzések tehát SGML-beli konstrukciók, és általában csak a DTD-ben érvényes a használatuk. A 3.4 Szakaszban viszont láthattuk, hogy az SGML szerkezetei akár a dokumentumokban is használhatóak.

Az SGML megjegyzéseket “`--`” szimbólumok használatával határolhatjuk el. A szimbólum első előfordulásával kezdjük a megjegyzést és a másodikkal zárjuk le.

Példa 3-8. Általános SGML megjegyzés

    <!-- próba megjegyzés -->

    <!-- Most a megjegyzés belsejében vagyunk -->

    <!-- Ez pedig egy másik megjegyzés    -->

    <!-- Így lehet például
         többsoros megjegyzéseket írni -->

    <!-- Ez egy másik módja a   --
      -- többsoros megjegyzések írásának -->

Ha dolgoztunk már korábban HTML kóddal, akkor előfordulhat, hogy más meghatározást láttunk a megjegyzésekre. Ezért tévesen azt gondolhattuk, hogy a megjegyzéseket a `<!--` karaktersorozat vezeti be, és csak a `-->` zárhatja le.

Valójában viszont nem így van. Sok böngésző hibás HTML elemzőt tartalmaz, ezért ezt érvényesnek fogadják el. A Dokumentációs Projektben használt SGML elemzők azonban ennél sokkal szigorúbbak és az ilyen hibás dokumentumokat visszadobják.

Példa 3-9. Hibás SGML megjegyzések

    <!-- Most egy megjegyzés belsejében vagyunk --

         KÍVÜL VAGYUNK A MEGJEGYZÉSEN!

      -- ismét megjegyzésben vagyunk -->

Az SGML elemző ezt valahogy így fogja értelmezni:

    <!KÍVÜL VAGYUNK A MEGJEGYZÉSEN>

Ez nem szabályos SGML és ráadásul félrevezető hibaüzenetet eredményez.

    <!------------------ Ez nem szép dolog! ----------------->

A példa szövege szerint sem javasolt ilyen megjegyzéseket írni.

    <!--===================================================-->

Ez már (valamivel) értelmesebb megoldás, de még feláll a veszélye, hogy megtéveszti az SGML-ben járatlan olvasókat.

## 3.5.1. Egy kis gyakorlás...

1. Tegyünk néhány megjegyzést a korábban készített `próba.sgml` állományunkba, majd az `onsgmls` segítségével ellenőrizzük, hogy közben érvényes marad.

2. Tegyünk néhány érvénytelen megjegyzést a `próba.sgml` állományba, majd nézzük meg, hogy az `onsgmls` milyen hibaüzeneteket ad rájuk.

Előző | Tartalom | Következő
Visszaváltás az SGML használatára | Fel | Egyedek

Ha kérdése van a FreeBSD-vel kapcsolatban, a következő címre írhat (angolul): <freebsd-questions@FreeBSD.org>.
Ha ezzel a dokumentummal kapcsolatban van kérdése, kérjük erre a címre írjon: <gabor@FreeBSD.org>.