Komentāri Java – optimāla izmantošana iesācējiem

Koda izpratne ir izšķirīga, kad sāc programmēšanu. Komentāri ir svarīgs, taču bieži nenovērtēts elements kodā, kas var ievērojami atvieglot tavu darbu. Tie palīdz ne tikai pašam tev, uzturot kodu vēlāk, bet arī citiem izstrādātājiem, kuri strādā ar tavu kodu. Šajā rokasgrāmatā tu uzzināsi, kā pievienot komentārus Java valodā un kādas formas tie ir.

Svarīgākās atziņas

• Komentāri uzlabo tava koda lasāmību.
• Ir dažādi komentāru veidi: rindu balstīti un bloku komentāri.
• JavaDoc piedāvā strukturētu veidu, kā izveidot dokumentāciju tavu klasēm un metodēm.

Komentāru izmantošana Java

Java valodā tu vari pievienot komentārus divos veidos: rindu balstīti vai kā bloku komentārus. Zemāk es paskaidrošu dažādus komentāru veidus un kā tu vari tos efektīvi izmantot.

Rindu balstīti komentāri

Rindu balstīti komentāri ir vienkārši un tieši. Tu sāc jaunu komentāru ar //. Viss, kas nāk pēc šī simbola, tiks ignorēts no kompilatora. Tas ir īpaši noderīgi, lai pievienotu īsas paskaidrojuma piezīmes konkrētām koda rindām.

Vienkāršs piemērs:

// Tas ir rindu balstīts komentārs
int a = 1; // Inicializēju mainīgo a ar vērtību 1
int b = 2; // Inicializēju mainīgo b ar vērtību 2

Pievienojot komentārus izšķirošās vietās, tu iegūsi skaidrību par tava koda darbību.

Bloku komentāri

Vērienīgām paskaidrojumiem, kas aptver vairākas rindas, piemēroti ir bloku komentāri. Tu uzsāk bloku komentāru ar /* un beidz to ar */. Viss starp šiem simboliem tiks ignorēts no kompilatora. Tas ir īpaši noderīgi, ja vēlies komentēt garas paskaidrojumus vai pat vairākas koda rindas.

Vienkāršs piemērs:

/* Tas ir bloku komentārs.
Šeit es dokumentēju šādas mainīgās:
a - tiek izmantots, lai saglabātu vērtību ievadei.
b - tiek izmantots, lai saglabātu vērtību izejai.
*/
int a = 1;
int b = 2;

Izmantojot bloku komentārus, tu vari arī vienkārši ietilpināt lielākus paskaidrojumus.

JavaDoc komentāri

JavaDoc izmanto speciālu sintaksi, lai ģenerētu dokumentāciju tavu klasēm un metodēm. Šie komentāri sākas ar /** un beidzas ar */. Starp šiem marķējumiem tu vari izmantot speciālus tagus, lai sniegtu informāciju par parametriem, atgrieztajām vērtībām un izņēmumiem.

Vienkāršs piemērs varētu izskatīties šādi:

/** * Šī metode pieskaita divas skaitļus. * * @param a pirmais skaitlis * @param b otrais skaitlis * @return a un b summa */
public int saskaitīt(int a, int b) { return a + b;
}

Šis komentārs parāda manai izstrādes videi un citiem izstrādātājiem, kā metoda darbojas un ko no tās var gaidīt.

Koda strukturēšana ar komentāriem

Komentāri nav noderīgi tikai komunikācijai ar citiem izstrādātājiem, bet arī palīdz strukturēt tavu kodu. Ja, piemēram, tev ir gara metode ar vairākām atbildībām, tu vari izmantot bloku komentārus, lai atzīmētu dažādus posmus.

// Posms: Datu nolasīšana
// Šeit būs kods datu nolasīšanai

// Posms: Datu apstrāde // Šeit būs kods datu apstrādei

// Posms: Rezultātu izvadīšana // Šeit būs kods rezultātu izvadīšanai

Pateicoties šādiem komentāriem, tu iegūsi skaidru vizuālu atdalīšanu starp dažādiem loģikas posmiem tavā kodā.

Kopsavilkums

Komentāru izmantošana Java ir būtiska, lai padarītu tavas programmas lasāmas un uzturamas. Ir divi pamatveidi komentāriem: rindu balstīti komentāri un bloku komentāri, kā arī speciāli JavaDoc komentāri dokumentācijai. Ja tu komentārus rūpīgi un jēgpilni izmanto, tas ne tikai padarīs tavu kodu saprotamāku citiem, bet arī tev pašam, veicot nākotnes izmaiņas.