Kako uporabljati komentarje v kodi Java

Komentarji Java so opombe v datoteki Java kodo, ki jih prevajalnik in izvajalnik ne upoštevajo. Uporabljajo se za označevanje kode, da se razjasni njena zasnova in namen. V datoteko Java lahko dodate neomejeno število komentarjev, vendar je pri uporabi komentarjev treba upoštevati nekaj "najboljših praks".

Na splošno so komentarji kode komentarji "izvajanja", ki pojasnjujejo izvorno kodo, kot so opisi razredov, vmesnikov, metod in polj. Običajno gre za nekaj vrstic, napisanih zgoraj ali poleg Java-kode, da bi pojasnili, kaj počne.

Druga vrsta komentarja Java je komentar Javadoca. Komentarji Javadoca se po sintaksi nekoliko razlikujejo od komentarjev izvedbe in jih program javadoc.exe uporablja za ustvarjanje dokumentacije Java HTML.

Dobra praksa je, da v navado vnesete komentarje Java v svojo izvorno kodo, da izboljšate njeno berljivost in jasnost zase in za druge programerje. Ni vedno takoj jasno, kaj odsek kode Java izvaja. Nekaj ​​obrazložitev lahko drastično zmanjša čas, potreben za razumevanje kode.

Pripombe k izvajanju v Java koda so tam samo zato, da ljudje berejo. Java prevajalnike ne zanima in kdaj in kdaj sestavljanje programa, samo preskočijo jih. Na velikost in učinkovitost vašega sestavljenega programa ne bo vplivalo število komentarjev v izvorni kodi.

Komentarji izvajanja so v dveh različnih oblikah:

• Komentarji vrstice: Za komentar v eni vrstici vnesite "//" in sledite dvema poševnima črtama. Na primer:

   // to je komentar v eni vrstici
  int предполагаNumber = (int) (Math.random () * 10); 

  Ko prevajalnik naleti na dve poševni poševnici, ve, da je vse, kar je desno od njih, treba obravnavati kot komentar. To je uporabno pri odpravljanju napak pri kodi. Dodajte komentar iz vrstice kode, ki jo odpravljate, in prevajalnik je ne bo videl:

  •  // to je komentar v eni vrstici
    // int pogoditi število = (int) (Math.random () * 10); 

    Za zaključek komentarja vrstice lahko uporabite tudi dve poševni liniji:

  •  // to je komentar v eni vrstici
    int предполагаNumber = (int) (Math.random () * 10); // Komentar na koncu vrstice 

• Blokiraj komentarje: Za začetek komentarja v bloku vnesite "/ *". Vse med nagnjeno črto in zvezdico, tudi če je v drugi vrstici, se obravnava kot komentar, dokler junaki "* /" ne končajo komentarja. Na primer:

   / * to 
  je 
  a
  blok
  komentar
  */
  / * tako je tudi * /
  

Za dokumentiranje Java API-ja uporabite posebne komentarje Javadoca. Javadoc je orodje JDK, ki ustvarja HTML dokumentacijo iz komentarjev v izvorni kodi.

Javadoc komentar v

.java

/**

*/

*

Te komentarje postavite neposredno nad metodo, razred, konstruktor ali kateri koli drug element Java, ki ga želite dokumentirati. Na primer:

// myClass.java
/**
* Naj bo ta povzetek stavka, ki opisuje vaš razred.
* Tukaj je še ena vrstica.
*/
javnostirazred moj razred
{
...
}

Javadoc vključuje različne oznake, ki nadzorujejo, kako nastaja dokumentacija. Na primer

@param

 / ** glavna metoda
* @param args String []
*/​
javnostistatičnanična glavni (strune [] args)
​{
System.out.println ("Pozdravljeni svet!");
}

V Javadocu so na voljo številne druge oznake, poleg tega pa podpira tudi oznake HTML, s katerimi lahko nadzorujete izhod. Za podrobnosti si oglejte dokumentacijo Java.

• Ne komentirajte. Vsake vrstice vašega programa ni treba razlagati. Če vaš program teče logično in se ne zgodi nič nepričakovanega, ne dodajte komentarja.
• Vstavite svoje komentarje. Če je vrstica kode, ki jo komentirate, zamiknjena, se prepričajte, da se vaš komentar ujema z vdolbinico.
• Naj bodo komentarji ustrezni. Nekateri programerji so odlični pri spreminjanju kode, vendar iz nekega razloga pozabijo posodobiti komentarje. Če komentar ne velja več, ga bodisi spremenite bodisi odstranite.
• Ne gnezdi blokov komentarjev. Naslednje bo povzročilo napako prevajalnika:

   / * to 
  je
  / * Ta blok komentar zaključi prvi komentar * /
  a
  blok
  komentar
  */