Sådan oprettes javadoc Når kommentar

javadoc er de facto standard for at generere dokumentation fra kildekode.Det er et redskab til at skabe HTML-dokumentation fra specielt formaterede kommentarer i Java-kode.Dette kan bruges til at generere struktureret application programming interface (API) dokumentation automatisk, give nogle hints til IDE eller til tildeling af pakker, klasser og metoder.Væsentlige, det er en måde at kommentere parameterbeskrivelser, der skrev hvad, og hvem har skylden, hvis det bryder.Java kommer med javadoc kommandolinje-program til at generere HTML dokumentation, men de fleste Java integrerede udviklingsmiljøer (IDE'er) har også denne integrerede.

Instruktioner

  1. Opret særlige javadoc kommentarer.Til at betegne en javadoc kommentar, skal du starte kommentar med / .Javadoc kommentarer, findes normalt i toppen af ​​en fil, før klasser og før metoder.Da det er designet til fuld API dokumentation, er det ikke ualmindeligt at se filer med flere javadoc kommentarer end kode. "" /
    Dette er en javadoc kommentar.Det har ikke nogen javadoc meta-tags endnu, men det gjorde udløse javadoc parser til at tage et kig på denne kommentar.
    / ""

  2. Tilføj API meta-tags (tags, der beskriver API selv), når kommentere.API tags er parameter navne, beskrivelser, undtagelse profiler, returværdi beskrivelser, metode navne og metodebeskrivelser.Mange IDE'er indarbejde disse data i deres værktøjstip og andre hjælpere, såvel som det er til brug i HTML eller kommentar form.

  3. Brug metodebeskrivelsen.Dette meta-tag har ingen tags navn: Det er simpelthen den kommentar, der kommer før de andre mærker "" / *
    Beregner hældningen af ​​en linje..
    * / ""

  4. Indarbejd parameterbeskrivelser.Disse er angivet med @ param meta-tags, som skal følges af en parameter navn og en beskrivelse. "" / *
    Beregner hældningen af ​​en linje.

    @ param p1 første punkt, der beskriver linjen
    @ param p2 andet punkt, der beskriver linjen
    / ""

  5. Returværdi beskrivelser.Dette er angivet ved denreturn meta-tag og bør følges op af en beskrivelse af returværdien. "" / *
    Beregner hældningen af ​​en linje.

    @ param p1 første punkt, der beskriver linjen
    @ param p2 andet punkt, der beskriver linjen
    return Slope af linjen som en float
    * / ""

  6. Tilføj henføringsmetoder tags.Mærkerne tilskriver koden til en bestemt forfatter. "" / *
    Beregner hældningen af ​​en linje.

    Author Jack Smith
    @ param p1 første punkt, der beskriver linjen
    @ param p2 andet punkt, der beskriver linjen
    return Slope af linjen som en float
    / ""

  7. Generer HTML dokumentation.Hvis du ikke bruger en IDE eller du blot ønsker at gøre det manuelt, kan du køre javadoc kommandolinjen program fra dit projekt mappe.Angiv output mappe med -d switch og give det en liste over .java filer (normalt som et wildcard). "" Javadoc -d docs * .java ""

Tips & amp;Advarsler

  • Når du bruger en IDE, er HTML-dokumentation formentlig gjort automatisk som en del af byggeprocessen.Der henvises til din IDE dokumentation for at bekræfte dette.
  • flere linjer kommentarer i Java traditionelt starter med /
  • , men den ekstra stjerne tegn i javadoc signalerer javadoc parser til at begynde at lede efter javadoc meta-tags.
157
0
1
Java Programmering