( hrgy84 | 2011. 03. 14., h – 17:59 )

Ez hulyeseg.

Ado tt egy ilyen kod (most java kodot irok, mert a problema egyertelmu, viszont nem kell a html entitasokkal nyuglodni):


public class EgyOsztaly {
  /**
  * Kiszamolja az elet ertelmet, es visszater az ertekevel
  * @returns: az elet ertelme
  */
  public int getEletErtelme() {
    return 42;
  }

  /**
   * A pokol hivoszamat adja meg
   * @returns A pokol hivoszama
   */
  public int getPokolHivoszama() {
    return 666;
  }
  
  public static void main(String[] args) {
    System.out.println("Teszt");
  }
}

Most, mondjuk a pokol hivoszamat ki akarod kommentezni, mert az gonosz dolog. Ugyanakkor arra is figyelned kell, hogy azert ez a dolog megmaradjon (nyilvan ezert nem torlod ki), csak epp most nincs ra szukseged. Valami ilyesmi lesz a vege:



/*
  /**
   * A pokol hivoszamat adja meg
   * @returns A pokol hivoszama
   */
  public int getPokolHivoszama() {
    return 666;
  }
*/

1) Miert nem jo, ha csak a kodot kommentezed ki?
Azert, mert akkor a javadoc a public static void main(String[]) fuggvenyre vonatkozna, ami viszont egyertelmuen hibas, hiszen ennek a fuggvenynek nincs ervenyes visszateresi erteke(void), raadasul csunyan elrontja az osztaly dokumentaciojat is.
2) Miert nem toroljuk ki?
Azert, mert ez a kod csak a peldaban ilyen rovid. Lehet hogy a kod sokkal hosszabb, es tobb ido helyreallitani, mintha csak kikommenteznenk.

Egy modern ertelmezonek nem szabad azon fennakadnia, hogy egy kommenten belul van egy komment.

--

Ki oda vagyik, hol szall a galamb, elszalasztja a kincset itt alant. | Gentoo Portal