Kommentaarid Java's - Optimaalne kasutamine algajatele

Koodi mõistmine on oluline, kui alustad programmeerimist. Komentaarid on tähtis, kuid sageli alahinnatud element koodis, mis võib sinu tööd oluliselt lihtsustada. Need aitavad mitte ainult sul endal koodi hilisemal hooldamisel, vaid ka teistel arendajatel, kes töötavad sinu koodiga. Käesolevas juhendis saad teada, kuidas lisada kommentaare Javas ja millised vormid eksisteerivad.

Olulisemad järeldused

• Komentaarid parandavad sinu koodi loetavust.
• On erinevaid kommentaaritüüpe: reaväärsed ja plokkkommentaarid.
• JavaDoc pakub struktureeritud viisi dokumentatsiooni loomiseks sinu klasside ja meetodite jaoks.

Komentaaride kasutamine Javaski

Java-s saad kommentaare lisada kahte moodi: reaväärselt või plokkkommentaarina. Järgnevalt selgitan erinevaid kommentaaritüüpe ja kuidas neid tõhusalt kasutada.

Reaväärsed kommentaarid

Reaväärsed kommentaarid on lihtsad ja otsekohesed. Sa alustad uut kommentaaririda märgiga //. Kõik, mis pärast seda märki tuleb, ignoreeritakse kompileerimise ajal. See on eriti kasulik, et lisada lühikesi selgitusi teatud koodiridade kohta.

Näide:

// See on reaväärne kommentaar
int a = 1; // Algata muutuja a väärtusega 1
int b = 2; // Algata muutuja b väärtusega 2

Kommendaaride lisamine olulistes kohtades annab sulle rohkem selgust sinu koodi toimimise üle.

Plokkkommentaarid

Ulatuslike selgituste jaoks, mis hõlmavad mitut rida, sobivad plokkkommentaarid. Sa alustad plokkkommentaari märgiga /* ja lõpetad selle märgiga */. Kõik nende kahe vahel ignoreeritakse kompileerimise ajal. See on eriti kasulik, kui soovid kommenteerida pikemaid selgitusi või isegi mitmeid koodiridu.

Näide:

/* See on plokkkommentaar.
Siin dokumenteerin järgmised muutujad:
a - kasutatakse väärtuse salvestamiseks sisendi jaoks.
b - kasutatakse väärtuse salvestamiseks väljundi jaoks.
*/
int a = 1;
int b = 2;

Plokkkommentaaride kasutamine võimaldab sul ka suuremaid selgitusi hõlpsasti mahutada.

JavaDoc kommentaarid

JavaDoc kasutab erilist süntaksit, et genereerida dokumentatsiooni sinu klasside ja meetodite jaoks. Need kommentaarid algavad märgiga /** ja lõpevad märgiga */. Nende märkide vahel saad kasutada erilisi silte, et anda teavet parameetrite, tagastatud väärtuste ja erandite kohta.

Lihtne näide võiks olla selline:

/** * See meetod liidab kaks arvu. * * @param a esimene number * @param b teine number * @return summa a ja b */
public int liida(int a, int b) { return a + b;
}

See kommentaar näitab minu arenduskeskkonnale ja teistele arendajatele, kuidas meetod töötab ja mida nad sellelt oodata võivad.

Koodi struktureerimine kommentaaridega

Komentaarid ei ole kasulikud ainult teiste arendajatega suhtlemiseks, vaid aitavad kaasa ka sinu koodi struktuuri loomisele. Kui sul on näiteks pikk meetod, millel on mitu vastutust, saad kasutada plokkkommentaare, et tähistada erinevaid lõike.

// Lõik: Andmete lugemine
// Siia tuleb kood andmete lugemiseks

// Lõik: Andmete töötlemine // Siia tuleb kood andmete töötlemiseks

// Lõik: Tulemustest teavitamine // Siia tuleb kood tulemuste väljundiks

Selliste kommentaaride kaudu saavutad selge visuaalse eristamise sinu koodi erinevate loogika lõikude vahel.

Kokkuvõte

Komentaaride kasutamine Java-s on hädavajalik osa, et muuta sinu programmid loetavaks ja hooldatavaks. On kaks põhiliiki kommentaare: reaväärsed kommentaarid ja plokkkommentaarid, samuti erilised JavaDoc kommentaarid dokumentatsiooni jaoks. Kui sa kasutad kommentaare hoolikalt ja mõistlikult, muutub sinu kood mitte ainult teistele arusaadavamaks, vaid ka sulle endale tulevikus muudatuste tegemisel.