Hoe te Javadoc maken wanneer een reactie

Javadoc is de de facto standaard voor het genereren van documentatie vanuit de broncode.Het is een tool om HTML-documentatie van speciaal opgemaakte opmerkingen in Java code.Dit kan worden gebruikt om gestructureerde application programming interface (API) documenten automatisch te genereren, geven enkele tips om de IDE of voor toekenning van pakketten, klassen en methoden.In wezen, het is een manier van commentaar op parameterbeschrijvingen, wie wat schreef, en die de schuld als het breekt.Java wordt geleverd met de javadoc command-line programma om de HTML-documentatie te genereren, maar de meeste Java-geïntegreerde ontwikkelomgevingen (IDE) hebben ook deze geïntegreerde.

instructies

  1. Maak speciale javadoc opmerkingen.Om een ​​reactie te geven javadoc, start de reactie met / .Javadoc reacties bestaan ​​meestal boven in een bestand voor klassen en voor werkwijzen.Omdat het is ontworpen voor volledige API-documentatie, is het niet ongewoon om bestanden te zien met me

    er javadoc opmerkingen dan code. "" /
    Dit is een javadoc commentaar.Het heeft geen javadoc meta-tags nog niet, maar het deed leiden tot de javadoc parser om een ​​kijkje op deze reactie te nemen.
    / ""

  2. Voeg API meta-labels (tags die de API zelf beschrijven) als commentaar.API tags zijn parameter namen, beschrijvingen, behalve profielen, beschrijvingen return waarde, methode namen en methode beschrijvingen.Veel IDE's te nemen van deze gegevens in hun tooltips en andere hulpverleners, evenals het feit dat het voor gebruik in HTML of reactieformulier.

  3. Met de methode beschrijving.Deze meta-tag heeft geen tag naam: Het is gewoon de opmerking dat voor de andere labels "" / *
    Berekent de helling van een lijn..
    * / ""

  4. Incorporate parameter beschrijvingen.Deze worden aangegeven met param meta-tags die moet worden gevolgd door een parameter naam en beschrijving. '' / *
    Berekent de helling van een lijn.

    param p1 eerste punt dat de lijn
    param p2 tweede punt dat de lijn
    / ""

  5. Return omschrijvingen waarde beschrijft beschrijft.Dit wordt aangegeven metreturn meta-tag en moet worden gevolgd door een beschrijving van de retourwaarde. '' / *
    Berekent de helling van een lijn.

    param p1 eerste punt dat de lijn
    param p2 tweede punt dat de lijn
    beschrijftreturn Helling van de lijn als een float
    * / "beschrijft"

  6. toevoegen attributie-tags.De tags schrijven de code om een ​​bepaalde auteur. "" / *
    Berekent de helling van een lijn.

    Author Jack Smith
    param p1 eerste punt dat de lijn
    param p2 tweede punt dat de lijn
    beschrijftreturn Helling van de lijn als een vlotter
    / ""

  7. beschrijfthet genereren van de HTML-documentatie.Als je niet met behulp van een IDE of wil je gewoon handmatig te doen, kunt u de javadoc command-line programma uitvoeren vanaf uw project directory.Geef de output directory met de -d switch en geef het een lijst van .java bestanden (meestal als een wildcard). "" Javadoc -d docs * .java ""

Tips & amp;Waarschuwingen

  • Wanneer u gebruik maakt van een IDE, wordt HTML-documentatie waarschijnlijk automatisch uitgevoerd als onderdeel van het bouwproces.Raadpleeg uw IDE documentatie om dit te bevestigen.
  • Multi-line commentaar in Java traditioneel beginnen met /
  • , maar de extra sterretje in Javadoc signaleert de javadoc parser om te beginnen op zoek naar javadoc metatags.
223
0
1
Programmeren In Java