Comentarii în fișierul sursă

Comentariile sunt texte care pot fi introduse în programul sursă, dar nu sunt luate în considerație de compilator și deci nu au efect în timpul executării programului. Comentariile sunt utile pentru o mai buna înțelegere a programului de către om.

În programele Java, se pot folosi trei feluri de comentarii:
    a/ comentarii care se pot extinde pe una sau mai multe linii și au forma
    /* <comentariu> */
    b/ comentarii de sfarsit de linie, care incep cu simbolul // si continua pana la sfarsitul liniei respective, deci au forma
    // <comentariu>
    c/ comentarii care sunt destinate reproducerii în documentația clasei și au forma
    /** <comentariu>*/
deci se deosebesc formal de cele de la punctul a numai prin faptul ca incep cu simbolul /**.

Primele două forme de comentariu există și în limbajul C++, în timp ce ultima este specifică numai limbajului Java.
 
Exemplu
Dăm aici ca exemplu fișierul Comentarii.java, care are la bază fișierul PrimaAplicatie.java, dar  acesta fost completat cu comentarii.
/** Aplicatie in care se exemplifica folosirea celor trei tipuri de comentarii permise in limbajul Java */

 class Comentarii { // aici incepe definitia clasei Comentarii

    /* metoda main este metoda principala a clasei, cu care
       incepe executarea programului */

      public static void main(String args[]) {

        /* Urmeaza instructiunea prin care se invoca metoda
           println pentru afisarea unui text */
         System.out.println("Prima noastra aplicatie a reusit!");

      }  // sfarsitul metodei main

   }  // sfarsitul clasei Comentarii

Dacă vom compila și pune în executie această aplicație, vom constata că efectul este același ca în cazul clasei PrimaAplicație, deoarece comentariile introduse în fișierul sursă nu au efect în timpul execuției programului.

OBSERVAȚIE: Comentariile sunt absolut necesare pentru înțelegerea programului. În același timp, abuzul de comentarii poate să facă urmarirea acestuia dificilă. Este, deci, recomandabil să se introducă în program toate comentariile necesare pentru o bună înțelegere a acestuia, dar nu mai mult. La aprecierea programelor scrise de Dvs. se va lua întotdeauna în considerație prezența și calitatea comentariilor.



© Copyright 2000 - Severin BUMBARU, Universitatea "Dunărea de Jos" din Galați