Kuinka käyttää kommentteja Java-koodissa

Java-kommentit ovat Java-kooditiedoston muistiinpanoja, joita kääntäjä ja ajonaikainen moottori jättävät huomioimatta. Niitä käytetään merkitsemään koodi koodin rakenteen ja tarkoituksen selventämiseksi. Voit lisätä rajoittamattoman määrän kommentteja Java-tiedostoon, mutta joitain "parhaita käytäntöjä" on noudatettava käytettäessä kommentteja.

Koodikommentit ovat yleensä "toteutuksen" kommentteja, jotka selittävät lähdekoodi, kuten luokkien, rajapintojen, menetelmien ja kenttien kuvaukset. Nämä ovat yleensä pari riviä, jotka on kirjoitettu Java-koodin yläpuolelle tai viereen selventämään, mitä se tekee.

Toinen Java-kommenttityyppi on Javadoc-kommentti. Javadoc-kommentit eroavat hieman syntaksissa toteutuskommentteista, ja javadoc.exe -ohjelma käyttää niitä Java HTML -dokumentaation luomiseen.

Hyvä käytäntö on saada tapana laittaa Java-kommentteja lähdekoodiin parantaaksesi luettavuutta ja selkeyttä itsellesi ja muille ohjelmoijille. Ei ole aina heti selvää, mitä Java-koodin osa suorittaa. Muutama selittävä rivi voi vähentää huomattavasti koodin ymmärtämiseen kuluvaa aikaa.

Toteutusta koskevat kommentit Java-koodi ovat vain ihmisten luettavissa. Java-kääntäjät eivät välitä niistä milloin ohjelman kokoaminen, he vain ohittavat ne. Lähdekoodisi kommenttien määrä ei vaikuta käännetyn ohjelman kokoon ja tehokkuuteen.

Toteutusta koskevat kommentit ovat kahta eri muotoa:

• Rivikommentit: Kirjoita yhden rivin kommentti kirjoittamalla "//" ja seuraa kahta eteenpäinviivaa kommenttisi kanssa. Esimerkiksi:

   // tämä on yhden rivin kommentti
  int guessNumber = (int) (Math.random () * 10); 

  Kun kääntäjä törmää kahteen eteenpäinviivaan, se tietää, että kaikkea oikealla puolella on pidettävä kommenttina. Tämä on hyödyllistä, kun vianetsyt koodinpätkää. Lisää vain kommentti virhekoodin riviltä, ​​jota kääntäjä ei näe:

  •  // tämä on yhden rivin kommentti
    // int arvausnumero = (int) (Math.random () * 10); 

    Voit käyttää kahta eteenpäinviivaa myös rivin lopun kommentin tekemiseen:

  •  // tämä on yhden rivin kommentti
    int guessNumber = (int) (Math.random () * 10); // Rivin lopun kommentti 

• Estä kommentit: Aloita lohkokommentti kirjoittamalla "/ *". Kaikkia eteenpäinviivan ja tähdellä merkittyä kohtia, vaikka ne olisivat eri rivillä, käsitellään kommenttina, kunnes merkit "* /" päättävät kommentin. Esimerkiksi:

   /* Tämä 
  On 
  
  lohko
  kommentti
  */
  / * niin on tämä * /
  

Käytä erityisiä Javadoc-kommentteja dokumentoidaksesi Java-sovellusliittymäsi. Javadoc on JDK: n mukana toimitettu työkalu, joka tuottaa HTML-dokumentaatiota lähdekoodin kommentteista.

Javadoc-kommentti

.java

/**

*/

*

Sijoita nämä kommentit suoraan menetelmän, luokan, rakentajan tai minkä tahansa muun Java-elementin yläpuolelle, jonka haluat dokumentoida. Esimerkiksi:

// myClass.java
/**
* Tee tästä yhteenvetolause, joka kuvaa luokkaasi.
* Tässä on toinen rivi.
*/
julkinenluokka luokkani
{
...
}

Javadoc sisältää erilaisia ​​tunnisteita, jotka hallitsevat dokumentaation luomista. Esimerkiksi

@param

 / ** päämenetelmä
* @param args merkkijono []
*/​
julkinenstaattinenmitätön main (merkkijono [] args)
​{
System.out.println ("Hei maailma!");
}

Javadocissa on saatavana monia muita tunnisteita, ja se tukee myös HTML-tunnisteita tulosteen hallitsemiseksi. Katso lisätietoja Java-dokumentaatiosta.

• Älä yli kommentoi. Jokaista ohjelman riviä ei tarvitse selittää. Jos ohjelma kulkee loogisesti ja mitään odottamatonta ei tapahdu, älä tunne tarvetta lisätä kommentti.
• Sisennä kommenttisi. Jos kommentoitava koodirivi on sisennetty, varmista, että kommenttisi vastaa sisennystä.
• Pidä kommentit asianmukaisina. Jotkut ohjelmoijat osaavat muokata koodia erinomaisesti, mutta jostain syystä unohda päivittää kommentit. Jos kommenttia ei enää sovelleta, joko muokata tai poistaa se.
• Älä pesä estää kommentteja. Seuraava johtaa kääntäjävirheeseen:

   /* Tämä 
  On
  / * Tämä estotoiminto viimeistelee ensimmäisen kommentin * /
  
  lohko
  kommentti
  */