Komentar

Iz MaFiRaWiki

Komentar je pomemben element vsakega programskega jezika. Čeprav na delovanje programa ne vpliva, pa je zelo pomemben pri samem programiranju in kasneje pri vzdrževanju programa.

Programski jeziki imajo komentiranje rešeno na zelo različne načine. Prvi programski jeziki so komentarjem namenili posebne vrstice, npr. C v prvem stolpcu pri Fortranu.

Pascal in Mathematica poznata poseben tip oklepajev (* *).

Značilna je tudi rešitev s posebnim znakom, npr. %, ki povzroči, da je vse na desno od njega v tej vrstici komentar.

Sodobni programski jeziki običajno poleg komentarjev v sami kodi omogočajo tudi vidno dokumentacijo programskih enot (npr. Usage v Mathematici), ki je ločena od same kode.

V Javi poznamo

  • enovrstične komentarje, ki segajo do konca vrstice (//),
  • večvrstične (/* ... */) in
  • dokumentacijske komentarje (/** ... */), na podlagi katerih Javadoc za vsak razred izdela HTML datoteko, ki je oblikovana podobno kot dokumentacija Jave.

Primer (Java):

/**
 * Primer dokumentacijskega komentarja
 * @author  Petra Udir
 * @version 0.1, 22.4.2006
 */

 // enovrstični komentar, sega le do konca vrstice  

 /* To je primer večvrstičnega komentarja,
ki ga prevajalnik zanemari.*/
Osebna orodja