Sisällysluettelo:

Mihin Javadoc-kommentit laitetaan?
Mihin Javadoc-kommentit laitetaan?

Video: Mihin Javadoc-kommentit laitetaan?

Video: Mihin Javadoc-kommentit laitetaan?
Video: "Артиллеристы, Сталин дал приказ!" Часть 1 | П.А.Михин | Аудиокнига участника Второй мировой войны 2024, Saattaa
Anonim

The javadoc apuohjelma antaa sinun laittaa sinun kommentteja aivan koodisi vieressä, sisällä ". java " lähdetiedostot. Kun olet tyytyväinen koodiisi ja kommentteja , käytät vain javadoc komento ja HTML-tyylisi dokumentointi luodaan automaattisesti sinulle.

Kuinka sitten lisäät kommentteja Javadociin?

Ota seuraavat asiat huomioon käyttäessäsi Lisää Javadoc-kommentti (Alt+Vaihto+J): Vastaan lisätä a kommentti kenttään, aseta kohdistin kenttäilmoituksen kohdalle. Vastaanottaja lisätä a kommentti menetelmään, sijoita kohdistin minne tahansa menetelmän tai sen ilmoituksen kohdalle.

mitä hyötyä Javadoc-kommenteista on? Javadoc on työkalu, joka tulee JDK:n mukana ja se on käytetty tuottamista varten Java koodidokumentaatio HTML-muodossa osoitteesta Java lähdekoodi, joka edellyttää dokumentaatiota ennalta määritetyssä muodossa. Seuraavassa on yksinkertainen esimerkki, jossa rivit sisällä /*…. */ ovat Java monirivinen kommentteja.

Tästä syystä, mihin laitan Javadocin?

Voit sijoittaa JavaDoc-kommentteja mihin tahansa kolmesta eri sijainnista lähdetiedostossa:

  1. Välittömästi ennen julkisen luokan julistamista.
  2. Välittömästi ennen julkisen kentän ilmoittamista.
  3. Välittömästi ennen julkisen menetelmän tai konstruktorin ilmoittamista.

Kuinka kirjoitan Javadoc-kommentteja Intellijissä?

3 vastausta. Menetelmäallekirjoitus luodaan kirjoittamalla /** + ja painamalla Enter-näppäintä Javadoc tyngät sinulle. Sinä pystyt käyttää toiminto Korjaa doc kommentti '. Sillä ei ole oletuspikanäppäintä, mutta voit määrittää sille Alt + Shift + J -pikanäppäimen näppäinkartassa, koska tätä pikanäppäintä ei käytetä mihinkään muuhun.

Suositeltava: