Mitä kommentilla tarkoitetaan ja mihin sitä voi käyttää?


XML-dokumentissa kommentilla tarkoitetaan lisähuomautusta, joka ei varsinaisesti kuulu dokumentin rakenteeseen tai sisältöön. Kommentti voi sisältää lähes mitä tahansa ja se voi kertoa mistä aiheesta tahansa. Esimerkiksi dokumentin kirjoittaja voi kertoa miksi hän valitsi tietyn otsikon, miksi hän on nimennyt tekstissään seikkailevan karhun Otsoksi tai miksi hän käyttää tiettyä lauserakennetta. Toisaalta dokumentin jatkokäsittelijä (oli se sitten ohjelma tai ihminen) voi lisätä kommentteja esimerkiksi kertoakseen mitkä kohdat dokumentista on käsitelty ja mitkä ei, miksi rakennetta on muutettu alkuperäisestä, jne.

Rakennemäärittelyissä kommentteja käytetään usein kertomaan lisätietoja rakenteista tai kuvaamaan esiteltävien rakenteiden käyttötarkoitusta. Kommentteja käytetään myös erottamaan esittelyjä toisistaan lukemisen helpottamiseksi.

Tässä vielä muutamia lisäesimerkkejä kommenttien käyttötavoista:

Kommenttien oleellisin piirre on, etteivät dokumentin lukijat yleensä näe niitä. Harvat ohjelmat näyttävät kommentteja, joten käyttäjän on kommentit nähdäkseen luettava dokumentin lähdekoodia. Kommentit ovat siten hyvä tapa kertoa asioita, jotka ovat itselle tai muille kirjoittajille ainakin hetkellisesti tärkeitä, mutta jotka eivät kiinnosta tai kuulu lukijalle.

Toisaalta kommentteihin ei kannata kirjoittaa mitään tärkeää, jonka pitäisi säilyä dokumenttia käsiteltäessä! Monet dokumenttia automaattisesti käsittelevät sovellukset tarkoituksella poistavat kommentit tai muuten vaan ohittavat ne kokonaan. Hyvin harvat ohjelmat ymmärtävät tai välittävät kommenttien sisällöstä. Kommentit ovatkin tarkoitettu lähinnä dokumenttia käsitteleville ihmisille, kuten dokumentin kirjoittajille.


Sivua on edellisen kerran päivitetty: 07.02.2000.
Kommentteja voi lähettää Henri Ruinille osoitteeseen ruini@cs.helsinki.fi.