Kaip naudoti komentarus Java kode

„Java“ komentarai yra „Java“ kodo failo pastabos, kurių kompiliatorius ir vykdymo variklis nepaiso. Jie naudojami kodui komentuoti, kad būtų aiškesnis jo dizainas ir paskirtis. Prie „Java“ failo galite pridėti neribotą skaičių komentarų, tačiau yra keletas „geriausių praktikų“, kurių reikia laikytis naudojant komentarus.

Paprastai kodo komentarai yra "įgyvendinimo" komentarai, paaiškinantys pirminis kodas, pavyzdžiui, klasių, sąsajų, metodų ir laukų aprašymus. Paprastai tai yra pora eilučių, parašytų aukščiau arba šalia „Java“ kodo, kad būtų paaiškinta, ką tai daro.

Kitas „Java“ komentaro tipas yra „Javadoc“ komentaras. „Javadoc“ komentarai šiek tiek skiriasi nuo diegimo komentarų sintaksės ir juos naudoja programa javadoc.exe, kad sugeneruotų „Java HTML“ dokumentus.

Kodėl verta naudoti „Java“ komentarus?

Geriausia praktika įprasti į „Java“ komentarus į šaltinį, kad jis būtų lengviau skaitomas ir aiškus sau ir kitiems programuotojams. Ne visada iš karto aišku, kokia „Java“ kodo dalis veikia. Keletas aiškinamųjų eilučių gali drastiškai sutrumpinti laiką, per kurį reikia suprasti kodą.

instagram viewer

Ar jie veikia programos vykdymą?

Įgyvendinimo komentarai „Java“ kodas yra tik žmonėms skaityti. „Java“ kompiliatoriai jiems nerūpi, kada ir kada programos sudarymas, tiesiog praleidžia pro juos. Kompiliuotos programos dydžiui ir efektyvumui įtakos neturės jūsų šaltinio kodo komentarų skaičius.

Įgyvendinimo komentarai

Įgyvendinimo komentarai pateikiami dviem skirtingais formatais:

Eilutės komentarai: Jei norite gauti vienos eilutės komentarą, įveskite „//“ ir atlikite du pasvirusius brūkšnius su savo komentaru. Pavyzdžiui:
```
 // tai vienos eilutės komentaras
int guessNumber = (int) (matematika.dalyvis () * 10); 
```
Kai kompiliatorius susiduria su dviem brūkšneliais į priekį, jis žino, kad viskas, kas yra dešinėje iš jų, turi būti vertinamas kaip komentaras. Tai naudinga derinant kodo fragmentą. Tiesiog pridėkite komentarą iš derinimo kodo eilutės, ir kompiliatorius to nematys:
- ```
 // tai vienos eilutės komentaras
// int guessNumber = (int) (matematika.dalyvis () * 10); 
```
  Norėdami komentuoti eilutės pabaigą, taip pat galite naudoti du pasvirusius brūkšnius į priekį:
- ```
 // tai vienos eilutės komentaras
int guessNumber = (int) (matematika.dalyvis () * 10); // Eilutės pabaigos komentaras 
```
Blokuoti komentarus: Norėdami pradėti blokuoti komentarą, įveskite „/ *“. Viskas tarp brūkšnio pirmyn ir žvaigždės, net jei jis yra kitoje eilutėje, yra traktuojamas kaip komentaras, kol simboliai „* /“ pasibaigia komentaru. Pavyzdžiui:
```
 / * tai 
yra 
a
blokuoti
komentuoti
*/
/ * taip yra šita * /
```

„Javadoc“ komentarai

Norėdami dokumentuoti „Java“ API, naudokite specialius „Javadoc“ komentarus. „Javadoc“ yra įrankis, įtrauktas į JDK ir kuris generuoja HTML dokumentus iš šaltinio kodo komentarų.

„Javadoc“ komentaras

.java

šaltinio failai yra įterpti į pradžios ir pabaigos sintaksę taip:

/**

*/

. Kiekvienas jų komentaras rašomas prieš

Padėkite šiuos komentarus tiesiai virš metodo, klasės, konstruktoriaus ar bet kurio kito „Java“ elemento, kurį norite dokumentuoti. Pavyzdžiui:

// „myClass.java“
/**
* Padarykite tai apibendrinančiu sakiniu, apibūdinančiu jūsų klasę.
* Štai dar viena eilutė.
*/
viešaiklasė Mano klasė
{
...
}

„Javadoc“ turi įvairių žymų, kurios kontroliuoja, kaip kuriama dokumentacija. Pavyzdžiui,

@param

žyma apibūdina metodo parametrus:

 / ** pagrindinis metodas
* @param args stygos []
*/
viešaistatinistuštuma pagrindinis (stygos [] args)
{
„System.out.println“ („Sveikas pasaulis!“);
}

„Javadoc“ yra daugybė kitų žymų, taip pat palaikomos HTML žymės, kurios padeda valdyti išvestį. Norėdami gauti daugiau informacijos, žiūrėkite „Java“ dokumentaciją.

Komentarų naudojimo patarimai

Nekomentuokite. Kiekvienos jūsų programos eilutės nereikia paaiškinti. Jei jūsų programa vyksta logiškai ir neįvyksta nieko netikėto, nejaučiate poreikio pridėti komentarą.
Įtraukite savo komentarus. Jei jūsų komentuojama kodo eilutė yra įtraukta, įsitikinkite, kad jūsų komentaras sutampa su įtrauka.
Laikykite komentarus aktualiais. Kai kurie programuotojai moka modifikuoti kodą, tačiau dėl kokių nors priežasčių pamiršta atnaujinti komentarus. Jei komentaras nebetaikomas, pakeiskite arba pašalinkite jį.

Nelikite blokuoti komentarų. Taip bus padaryta kompiliatoriaus klaida:

 / * tai 
yra
/ * Šis bloko komentaras užbaigia pirmąjį komentarą * /
a
blokuoti
komentuoti
*/