Turinys:

Kur dėti Javadoc komentarus?
Kur dėti Javadoc komentarus?

Video: Kur dėti Javadoc komentarus?

Video: Kur dėti Javadoc komentarus?
Video: Besh Korechi Prem Korechi | Koel | Jeet | Raja Chanda | Jeet Gannguli | Shaan | Akriti Kakar 2024, Gegužė
Anonim

The javadoc naudingumas leidžia įdėti tavo komentarus šalia jūsų kodo, viduje jūsų ". java " šaltinio failus. Kai būsite patenkinti savo kodu ir komentarus , jūs tiesiog paleidžiate javadoc komandą ir jūsų HTML stilių dokumentacija automatiškai sukuriamas jums.

Tada kaip pridėti komentarų prie „Javadoc“?

Naudodami atkreipkite dėmesį į šiuos dalykus Pridėti Javadoc komentarą (Alt + Shift + J): į papildyti a komentarą į lauką, nustatykite žymeklį ant lauko deklaracijos. Į papildyti a komentarą prie metodo, nustatykite žymeklį bet kurioje metodo arba jo deklaracijos vietoje.

kuo naudingi Javadoc komentarai? Javadoc yra įrankis, kuris pateikiamas kartu su JDK ir yra naudojamas generavimui Java kodo dokumentacija HTML formatu iš Java šaltinio kodą, kuriam reikalingi dokumentai iš anksto nustatytu formatu. Toliau pateikiamas paprastas pavyzdys, kur eilutės viduje /*…. */ yra Java kelių eilučių komentarus.

Taigi, kur dėti „Javadoc“?

„JavaDoc“komentarus galite įdėti į bet kurią iš trijų skirtingų šaltinio failo vietų:

  1. Iškart prieš paskelbiant viešąją klasę.
  2. Iškart prieš paskelbiant viešąjį lauką.
  3. Iškart prieš viešo metodo ar konstruktoriaus deklaravimą.

Kaip „Intellij“parašyti „Javadoc“komentarus?

3 atsakymai. Įvesdami /** +, tada paspausdami Enter viršuje, bus sukurtas metodo parašas Javadoc stuburo jums. Tu gali naudoti veiksmas „Pataisyti doc komentarą “. Jis neturi numatytojo sparčiojo klavišo, bet klavišų schemoje galite jam priskirti spartųjį klavišą Alt + Shift + J, nes šis spartusis klavišas niekam kitam nenaudojamas.

Rekomenduojamas: