Kommentit Java:ssa – Optimalinen käyttö aloittelijoille

Koodin ymmärtäminen on ratkaisevan tärkeää, kun alat ohjelmoida. Kommentit ovat tärkeä, mutta usein aliarvioitu elementti koodissa, joka voi huomattavasti helpottaa työtäsi. Ne auttavat paitsi sinua myöhemmin koodisi ylläpidossa, myös muita kehittäjiä, jotka työskentelevät koodisi kanssa. Tässä oppaassa opit, miten lisätään kommentteja Javassa ja mitä muotoja niillä on.

Tärkeimmät havainnot

• Kommentit parantavat koodisi luettavuutta.
• Kommentteja on erilaisia: rivikohtaisia ja lohkokohtaisia kommentteja.
• JavaDoc tarjoaa rakenteellisen tavan luoda dokumentaatioita luokillesi ja metodeillesi.

Kommenttien käyttö Java:ssa

Java:ssa voit lisätä kommentteja kahdella tavalla: rivikohtaisesti tai lohkokommentteina. Seuraavassa selitän eri kommenttityyppejä ja kuinka käytät niitä tehokkaasti.

Rivikohtaiset kommentit

Rivikohtaiset kommentit ovat yksinkertaisia ja suoria. Aloitat uuden kommenttirivin merkillä //. Kaikki tämän merkin jälkeen jäävä asia ohitetaan kääntäjän toimesta. Tämä on erityisen hyödyllistä lyhyiden selostusten lisäämiseksi tiettyihin koodiriveihin.

Esimerkki:

// Tämä on rivikohtainen kommentti
int a = 1; // Alustaa muuttujan a arvolla 1
int b = 2; // Alustaa muuttujan b arvolla 2

Lisäämällä kommentteja tärkeisiin kohtiin saat enemmän selkeyttä koodisi toiminnasta.

Lohkokommentit

Laajempia selostuksia, jotka kattavat useita rivejä, varten lohkokommentit ovat hyvä valinta. Aloitat lohkocommentin merkillä /* ja päätät sen merkillä */. Kaikki näiden merkkien välissä oleva asia ohitetaan kääntäjän toimesta. Tämä on erityisen hyödyllistä, kun haluat kommentoida pitkiä selostuksia tai jopa useita koodirivejä.

Esimerkki:

/* Tämä on lohkokommentti.
Täällä dokumentoin seuraavat muuttujat:
a - käytetään arvojen syöttämiseen.
b - käytetään arvojen tulostamiseen.
*/
int a = 1;
int b = 2;

Lohkokommenttien avulla voit myös helposti sisällyttää suurempia selostuksia.

JavaDoc kommentit

JavaDoc käyttää erityistä syntaksia luodakseen dokumentaatiota luokillesi ja metodeillesi. Nämä kommentit aloitetaan merkinnällä /** ja päätetään merkillä */. Näiden merkkien väliin voit käyttää erityisiä tageja antaaksesi tietoa parametreista, palautusarvoista ja poikkeuksista.

Yksinkertainen esimerkki voisi olla seuraavanlainen:

/** * Tämä metodi summataan kaksi numeroa. * * @param a ensimmäinen numero * @param b toinen numero * @return a:n ja b:n summa */
public int addiere(int a, int b) { return a + b;
}

Tämä kommentti näyttää kehitysympäristölleni ja muille kehittäjille, miten metodi toimii ja mitä siltä voidaan odottaa.

Koodin jäsentäminen kommenteilla

Kommentit eivät ole vain hyödyllisiä viestinnässä muiden kehittäjien kanssa, vaan ne myös auttavat jäsentämään koodiasi. Jos sinulla on esimerkiksi pitkä metodi, jossa on useita vastuita, voit käyttää lohkokommentteja erilaisten osien merkitsemiseksi.

// Osa: Tietojen lukeminen
// Täällä on koodi tietojen lukemiseen

// Osa: Tietojen käsittely // Täällä on koodi tietojen käsitlemiseen

// Osa: Tulosten näyttäminen // Täällä on koodi tulosten näyttämiseen

Tällaiset kommentit antavat sinulle selkeän visuaalisen eron koodisi eri loogisten osien välillä.

Yhteenveto

Kommenttien käyttö Java:ssa on olennainen osa ohjelmiesi lukemisen ja ylläpidon helpottamiseksi. On olemassa kaksi peruskommenttityyppiä: rivikohtaiset kommentit ja lohkokommentit, sekä erityiset JavaDoc kommentit dokumentaatioita varten. Kun käytät kommentteja huolellisesti ja tarkoituksenmukaisesti, koodisi ei ole vain ymmärrettävämmäksi muille, vaan myös itsellesi tulevaisuudessa muutoksia tehdessä.