Turinys:

Kaip rašyti Javadoc?
Kaip rašyti Javadoc?

Video: Kaip rašyti Javadoc?

Video: Kaip rašyti Javadoc?
Video: Intro to JavaDoc - 1 of 2 2024, Lapkritis
Anonim

Javadoc kodavimo standartas

  1. Parašyk Javadoc turi būti skaitomas kaip šaltinio kodas.
  2. Viešas ir saugomas.
  3. Naudokite standartinį stilių Javadoc komentarą.
  4. Naudokite paprastas HTML žymas, netinkamą XHTML.
  5. Naudokite vieną

    žyma tarp pastraipų.

  6. Naudokite vieną
  7. sąrašo elementų žyma.
  8. Apibrėžkite ryškų pirmąjį sakinį.

Šiuo atžvilgiu, kaip sukurti „Javadoc“?

pateikti klasės, sąsajos ar enum versiją. Pasirinkite „Generuoti JavaDoc “parinktį iš projekto meniu ir pasirodys vedlys. Nurodykite vietą JavaDoc failą kompiuteryje, pagal numatytuosius nustatymus jis bus C diske. Pasirinkite projektą, tada paketus, kuriems norite sukurti JavaDoc failą.

Vėliau kyla klausimas, kas yra javadokai ir kada jie turėtų būti naudojami? Javadoc yra įrankis, kuris pateikiamas kartu su JDK ir yra naudojamas „Java“kodo dokumentacijai generuoti HTML formatu iš „Java“šaltinio kodo, kuriam reikia dokumentacijos iš anksto nustatytu formatu. */ yra Java kelių eilučių komentarai. Panašiai eilutė, einanti prieš // yra Java vienos eilutės komentaras.

Atsižvelgiant į tai, kas yra „Javadoc Command“?

javadoc yra komandą - eilutės įrankis, skirtas išgauti specialius komentarus (vadinamus doc komentarais) iš Java šaltinio failų ir sukurti lengvai naudojamą HTML failų medį su jais. Komentaruose gali būti standartinio HTML žymėjimo ir javadoc @žymės. „Java“API specifikacija yra pavyzdys javadoc gamina.

Kaip atidaryti Javadoc failą?

Norėdami rasti Javadoc , naršykite į aplanką User (Windows 7 tai yra C:Users*Username*), tada eikite į sunspotfrcsdk/doc/ javadoc . Dukart spustelėkite rodyklę. html failą į atviras tai numatytojoje žiniatinklio naršyklėje.

Rekomenduojamas: