Komentarai Java – Optimalus naudojimas pradedantiesiems

Kodo supratimas yra pagrindinis, kai pradedate programuoti. Pastabos yra svarbus, tačiau dažnai nuvertintas elementas kode, kuris gali žymiai palengvinti jūsų darbą. Jos padeda ne tik jums patiems tvarkant kodą vėliau, bet ir kitiems kūrėjams, kurie dirba su jūsų kodu. Šiame vadove sužinosite, kaip įterpti pastabas į Java ir kokios jų formos egzistuoja.

Pagrindinės įžvalgos

• Pastabos pagerina jūsų kodo skaitomumą.
• Yra įvairių pastabų tipų: linijinės ir blokinės pastabos.
• JavaDoc siūlo struktūrizuotą būdą kurti dokumentaciją jūsų klasėms ir metodams.

Pastabų naudojimas Java

Java galite pridėti pastabų dviem būdais: linijiniu arba blokiniu būdu. Žemiau paaiškinsiu skirtingus pastabų tipus ir kaip juos efektyviai naudoti.

Linijinės pastabos

Linijinės pastabos yra paprastos ir tiesioginės. Jūs pradedate naują pastabos eilutę su //. Viskas, kas po šiuo simboliu, bus ignoruojama kompilatoriaus. Tai ypač naudinga, norint pridėti trumpus paaiškinimus tam tikroms kodo eilutėms.

Pavyzdys:

// Tai yra linijinė pastaba
int a = 1; // Inicijuoju kintamąjį a su verte 1
int b = 2; // Inicijuoju kintamąjį b su verte 2

Pridėdami pastabas svarbiose vietose, gaunate aiškesnį supratimą apie to, kaip veikia jūsų kodas.

Blokinės pastabos

Didelėms paaiškinimų, kurie apima kelias eilutes, reikia blokinių pastabų. Jūs pradedate blokinę pastabą su /* ir baigiate ją su */. Viskas tarp šių žymeklių bus ignoruojama kompilatoriaus. Tai ypač naudinga, kai norite komentuoti ilgas išsamius paaiškinimus arba net kelias kodo eilutes.

Pavyzdys:

/* Tai yra blokinė pastaba.
Čia dokumentuoju šiuos kintamuosius:
a - naudojamas įvesties vertei saugoti.
b - naudojamas išvesties vertei saugoti.
*/
int a = 1;
int b = 2;

Naudodami blokines pastabas, galite lengvai patalpinti ir ilgesnius paaiškinimus.

JavaDoc pastabos

JavaDoc naudoja specialią sintaksę dokumentacijai jūsų klasėms ir metodams generuoti. Šios pastabos prasideda su /** ir baigiasi su */. Tarp šių žymenų galite naudoti specialius žymeklius informacijai apie parametrus, grąžinimo vertes ir išimtis.

Paprastas pavyzdys gali būti toks:

/** * Ši metodas prideda dvi skaičius. * * @param a pirmasis skaičius * @param b antrasis skaičius * @return a ir b suma */
public int pridėti(int a, int b) { return a + b;
}

Ši pastaba rodo mano kūrimo aplinkai ir kitiems kūrėjams, kaip veikia metodas ir ko jie gali iš jo tikėtis.

Kodo struktūrizavimas su pastabomis

Pastabos yra naudingos ne tik bendraujant su kitais kūrėjais, bet ir padeda struktūrizuoti jūsų kodą. Pavyzdžiui, jei turite ilgą metodą su keliomis atsakomybėmis, galite naudoti blokines pastabas, kad pažymėtumėte skirtingas sekcijas.

// Skyrius: Duomenų nuskaitymas
// Čia bus kodas, skirtas duomenų nuskaitymui

// Skyrius: Duomenų apdorojimas // Čia bus kodas, skirtas duomenų apdorojimui

// Skyrius: Rezultatų išvedimas // Čia bus kodas, skirtas rezultatų išvedimui

Tokios pastabos suteikia aiškią vizualinę atskirtį tarp skirtingų logikos sekcijų jūsų kode.

Santrauka

Pastabų naudojimas Java yra esminė dalis, kad jūsų programos būtų skaitomos ir priežiūrimomis. Yra dvi pagrindinės pastabų rūšys: linijinės pastabos ir blokinės pastabos, taip pat specialios JavaDoc pastabos dokumentacijoms. Jei atidžiai ir prasmingai naudojate pastabas, jūsų kodas ne tik taps suprantamesnis kitiems, bet ir jums patiems ateityje keičiant.