Sisällysluettelo:

Kuinka kirjoitat Javadocin?
Kuinka kirjoitat Javadocin?

Video: Kuinka kirjoitat Javadocin?

Video: Kuinka kirjoitat Javadocin?
Video: Kuinka kirjoittaa kirja helposti? 2024, Marraskuu
Anonim

Javadoc-koodausstandardi

  1. Kirjoita Javadoc luettava lähdekoodina.
  2. Julkinen ja suojattu.
  3. Käytä vakiotyyliä Javadoc kommentti.
  4. Käytä yksinkertaisia HTML-tageja, ei kelvollista XHTML-koodia.
  5. Käytä singleä

    tagia kappaleiden väliin.

  6. Käytä singleä
  7. tunniste luettelon kohteille.
  8. Määrittele painava ensimmäinen lause.

Tässä suhteessa, kuinka teet Javadocin?

tarjota versio luokasta, käyttöliittymästä tai enum. Valitse Luo JavaDoc ” -vaihtoehto Project-valikosta ja ohjattu toiminto tulee näkyviin. Määritä sijainti JavaDoc tiedosto tietokoneellesi, se on oletuksena C-asemassa. Valitse projekti ja sitten paketit, joille haluat luoda JavaDoc tiedosto.

Myöhemmin kysymys kuuluu, mitä Javadocit ovat ja milloin niitä tulisi käyttää? Javadoc on työkalu, joka tulee JDK:n mukana ja se on käytetty Java-koodidokumentaation luomiseen HTML-muodossa Java-lähdekoodista, mikä edellyttää dokumentaatiota ennalta määritetyssä muodossa. */ ovat Java-monirivisiä kommentteja. Vastaavasti rivi, joka edeltää //, on Java yksirivinen kommentti.

Kun tämä otetaan huomioon, mikä on Javadoc Command?

javadoc on komento -line työkalu erikoiskommenttien (kutsutaan doc-kommenttien) poimimiseen Java-lähdetiedostoista ja helppokäyttöisen HTML-tiedostopuun luomiseen, joka sisältää ne. Kommentit voivat sisältää tavallisia HTML-merkintöjä ja javadoc @tunnisteet. Java API Specification on esimerkki siitä javadoc tuottaa.

Kuinka avaan Javadoc-tiedoston?

paikantaaksesi Javadoc , selaa käyttäjäkansioosi (Windows 7:ssä tämä on C:Users*Käyttäjänimi*) ja selaa sitten osoitteeseen sunspotfrcsdk/doc/ javadoc . Kaksoisnapsauta hakemistoa. html-tiedostoon avata se oletusselaimessasi.

Suositeltava: