Hogyan használjuk a megjegyzéseket a Java kódban

A Java megjegyzések olyan Java kódfájlban szereplő megjegyzések, amelyeket a fordító és a futásidejű motor figyelmen kívül hagy. Ezeket használják a kód megjegyzéséhez, annak tisztázása érdekében. Korlátlan számú megjegyzést fűzhet hozzá egy Java fájlhoz, de vannak néhány „bevált gyakorlat”, amelyet be kell tartani a megjegyzés használatakor.

Általában a kódmegjegyzés "végrehajtás" megjegyzés, amely magyarázza a forráskód, például az osztályok, interfészek, módszerek és mezők leírása. Ezek általában néhány sor, a Java kód fölött vagy mellé írva annak tisztázása érdekében, hogy mit tesz.

Egy másik típusú Java megjegyzés a Javadoc megjegyzés. A Javadoc megjegyzések szintaxisában kissé különböznek a végrehajtási megjegyzésektől, és a javadoc.exe program használja őket Java HTML dokumentáció előállításához.

Jó gyakorlat, hogy bekerüljön a Java megjegyzések forráskódjába, hogy javítsa olvashatóságát és érthetőségét önmaga és más programozók számára. Nem mindig egyértelmű, hogy a Java kód melyik része teljesít. Néhány magyarázat drasztikusan csökkentheti a kód megértéséhez szükséges időt.

Végrehajtási megjegyzések 2006 - ban Java kód csak az emberek olvashatják őket. A Java fordítókat nem érdekli őket és mikor a program összeállítása, csak átugorják őket. Az összeállított program méretét és hatékonyságát nem befolyásolja a forráskódban szereplő megjegyzések száma.

A végrehajtási megjegyzések kétféle formátumban jelennek meg:

• Sor megjegyzés: Egy soros megjegyzéshez írja be a "//" elemet, és kövesse a komment két előrejelző görgőjét. Például:

   // ez egy soros megjegyzés
  int guessNumber = (int) (Math.random () * 10); 

  Amikor a fordító találkozik a két előrejelző perjelrel, tudja, hogy a jobb oldalukon lévő mindent megjegyzésnek kell tekinteni. Ez akkor hasznos, ha egy kóddarabot hibakeresés közben végez. Csak adjon hozzá egy megjegyzést a hibázott kódsorból, és a fordító nem látja azt:

  •  // ez egy soros megjegyzés
    // int guessNumber = (int) (Math.random () * 10); 

    A sor előrehaladásának megjegyzéséhez a két előrejelző perjel is felhasználható:

  •  // ez egy soros megjegyzés
    int guessNumber = (int) (Math.random () * 10); // A sor végének megjegyzés 

• Megjegyzés blokkolása: A blokk megjegyzés indításához írja be a "/ *" billentyűt. Az előrejelző perjel és a csillag között minden, még akkor is, ha egy másik sorban van, megjegyzésként kezelik, amíg a "* /" karakterek be nem fejezik a megjegyzést. Például:

   / * ezt 
  jelentése 
  egy
  Blokk
  megjegyzés
  */
  / * tehát ez * /
  

Használjon speciális Javadoc megjegyzéseket a Java API dokumentálásához. A Javadoc a JDK-hez tartozó eszköz, amely HTML-dokumentációt generál a forráskódban található megjegyzésekből.

Javadoc megjegyzés

.Jáva

/**

*/

*

Helyezze ezeket a megjegyzéseket közvetlenül a dokumentálni kívánt módszer, osztály, kivitelező vagy bármely más Java elem fölé. Például:

// myClass.java
/**
* Hogy ez egy összefoglaló mondat, amely leírja az osztályát.
* Itt egy másik sor.
*/
nyilvánososztály az osztályom
{
...
}

A Javadoc különféle címkéket tartalmaz, amelyek szabályozzák a dokumentáció előállítását. Például a

@param

 / ** fő módszer
* @param args String []
*/​
nyilvánosstatikusüres main (karakterlánc [] args)
​{
System.out.println ("Hello World!");
}

Sok más címke is elérhető a Javadoc-ban, és támogatja a HTML-címkéket is a kimenet vezérléséhez. További részletek a Java dokumentációban találhatók.

• Ne kommentálj többet. A program minden sorát nem kell magyarázni. Ha a program logikusan folyik, és semmi váratlan nem történik, ne érezd, hogy megjegyzést kell hozzátenni.
• Behúzza a megjegyzéseit. Ha a hozzászóló kód sor behúzott, ellenőrizze, hogy a megjegyzés megegyezik-e a behúzással.
• Tartsd relevánsnak a megjegyzéseket. Néhány programozó kiválóan módosítja a kódot, de valamilyen oknál fogva elfelejti frissíteni a megjegyzéseket. Ha egy megjegyzés már nem érvényes, akkor módosítsa vagy távolítsa el.
• Ne blokkolja a blokkoló megjegyzéseket. A következő fordító hibát okoz:

   / * ezt 
  jelentése
  / * Ez a blokk megjegyzés befejezi az első megjegyzést * /
  egy
  Blokk
  megjegyzés
  */