Javadoc is de de facto standaard voor het genereren van documentatie vanuit de broncode . Het is een tool om HTML- documenten te maken van speciaal opgemaakte reacties in Java-code . Dit kan worden gebruikt om gestructureerde application programming interface ( API ) documentatie automatisch te genereren , geven enkele tips om de IDE of voor toekenning van pakketten , klassen en methoden . Wezen , het is een manier van commentaar op parameterbeschrijvingen , wie wat schreef , en wie 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 ontwikkelomgeving (IDE ) hebben ook deze geïntegreerd . Instructies
1 Maak speciale javadoc opmerkingen. Om aan te geven een reactie 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 , het is niet ongewoon om bestanden met meer javadoc commentaar dan code zien . " " /*** Dit is een reactie javadoc . Het heeft geen javadoc meta - labels niet hebt, maar het deed triggeren de javadoc parser om een kijkje op deze reactie nemen . * /" " kopen van 2 Voeg API meta - labels ( tags die de API zelf omschrijven ) als commentaar . API tags zijn parameters , beschrijvingen , behalve profielen , return waarde beschrijvingen , 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 Gebruik de methode beschrijving . Deze meta - tag heeft geen tag naam : Het is gewoon het commentaar dat voordat de andere tags komt " " /*** Berekent de helling van een lijn . . * /" "
4 Integreer parameterbeschrijvingen . Deze worden aangeduid met de @ param metatags , die moet worden gevolgd door een parameter naam en beschrijving . " " /*** Berekent de helling van een lijn . ** @ Param p1 eerste punt dat de lijn beschrijft * @ param p2 tweede punt dat de lijn * /" "
Return value beschrijvingen 5 beschrijft . Dit wordt aangeduid met de @ return meta - tag en moet worden gevolgd door een beschrijving van de return waarde . " " /*** Berekent de helling van een lijn . ** @ Param p1 eerste punt dat de lijn beschrijft * @ param p2 tweede punt dat de lijn beschrijft * @ return Helling van de lijn als een float * /" "
6 Voeg attributie tags. De tags schrijven de code om een bepaalde auteur . " " /*** Berekent de helling van een lijn . ** @ Auteur Jack Smith * @ param p1 eerste punt dat de lijn beschrijft * @ param p2 tweede punt dat de lijn beschrijft * @ return Helling van de lijn als een float * /" "
7 het genereren van de HTML-documentatie . Als je geen gebruik maakt 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 -schakelaar en geef het een lijst van . Java -bestanden ( meestal als een wildcard ) . " " Javadoc - d docs * . Java " "
< br > |
