Kommentit

Kommentteja voidaan käyttää lukuisiin tarkoituksiin. Yksi yleisimmistä käyttötavoista on antaa lisätietoja rakennemäärittelyn esittelyistä (esimerkki). Muita yleisiä käyttötapoja ovat esimerkiksi rakenteiden poistaminen väliaikaisesti dokumentti-ilmentymästä (esimerkki) ja dokumentti-ilmentymän jakaminen osiin koodin lukemisen helpottamiseksi (esimerkki). Näitä on käytetty mm. XML-määrittelyn XML-versiossa.

XML:ssä kommentit alkavat '<!--'-merkinnällä (jota kutsutaan kommentin aloitusmerkinnäksi tai alkutunnisteeksi) ja päättyvät '-->'-merkintään (jota kutsutaan kommentin lopetusmerkinnäksi tai lopputunnisteeksi). Kaikki näiden merkintöjen välissä olevat merkit kuuluvat kommentin sisältöön.

Kommentin sisältöä koskee vain muutama rajoitus:

• siinä ei saa olla '--'-merkkiparia (kiellon takana on XML:n SGML-perusta) ja
  
• sisältöön kuuluvien merkkien on täytettävä Char-sääntö.
  

Muuten sisältö voi käsitellä mitä tahansa asiaa ja olla mitä tahansa - jopa merkkausta. Yleensä jäsentimet, ja XML-sovellukset ylipäätään, vain ohittavat kommentin sisällön käsittelemättä sitä millään tavalla. Tämän vuoksi kommentin sisällössä olevaa merkkausta ei tunnisteta eikä esimerkiksi sisällössä olevia entiteettejä korvata vastaavalla tekstillä.

Kommenttien sijoittaminen XML-dokumenttiin

Peukalosäännön mukaan kommentteja voidaan käyttää missä tahansa merkkauksen ja merkkausesittelyjen ulkopuolella. Tarkemmin sanoen XML-määrittely sallii kommentteja seuraavissa kohdissa (suluissa sijoituksen salliva sääntö):

• XML-esittelyn ja rakenne-esittelyn välissä (Misc)
  
• jäsennetyissä ulkoisissa entiteeteissä heti sisältöesittelyn jälkeen (content)
  
• rakennemäärittelyn sisällä esittelyjen ja prosessointikomentojen ulkopuolella (markupdecl)
  
• rakenne-esittelyn ja dokumentti-ilmentymän välissä (Misc)
  
• dokumentti-ilmentymässä merkkauksen ulkopuolella (content)
  
• dokumentti-ilmentymän jälkeen (Misc)
  

Alla on esimerkkidokumentti, johon on sijoitettu kommentit kaikkiin sallittuihin kohtiin. Kommenttien sisällä suluissa on sääntö, joka sallii kyseisen sijoituksen.

<?xml version="1.0" ?>
<!-- kommentti (Misc) -->
<DOCTYPE x [
    <!-- kommentti (markupdecl) -->
    <!ELEMENT x     (y)+>
    <!-- kommentti (markupdecl) -->
    <!ELEMENT y     (#PCDATA)>
    <!-- kommentti (markupdecl) -->
]>
<!-- kommentti (Misc) -->
<x>
    <!-- kommentti (content) -->
    <y>xyz<!-- kommentti (content) --></y>
    <!-- kommentti (content) -->
</x>
<!-- kommentti (Misc) -->

Linkkejä

• Kommentteihin liittyvät säännöt