| javadoc | |
|---|---|
| Type | Dokumentationsgenerator |
| Udvikler | Sun Microsystems |
| Operativ system | på tværs af platforme |
| Hardware platform | Java virtuel maskine |
| nyeste version | 1,50 |
| Licens | GNU GPL 2 + "Classpath undtagelse" [1] |
| Internet side | docs.oracle.com/javase/8... |
Javadoc er en HTML -dokumentationsgenerator fra Sun Microsystems ' Java -kildekodekommentarer . Javadoc er en standard til dokumentation af Java- klasser . De fleste softwareudviklingsmiljøer genererer automatisk HTML - dokumentation ved hjælp af Javadoc.
Javadoc giver også en API til at skabe doclets og taglets , der giver programmøren mulighed for at analysere strukturen af en Java - applikation.
Dokumentationskommentarer bruges til:
Kommentaren skal i hvert tilfælde komme før det dokumenterede element.
| Liste over Javadoc- deskriptorer | ||
|---|---|---|
| Deskriptor | Beskrivelse | Gælder for |
| @author | Forfatter | klasse, grænseflade |
| @version | Version. Ikke mere end én deskriptor pr. klasse | klasse, grænseflade |
| @since | Angiver hvilken version der er tilgængelig fra | klasse, interface, felt, metode |
| @see | Link til et andet sted i dokumentationen | klasse, interface, felt, metode |
| @param | Metode input parameter | metode |
| @return | Beskrivelse af returværdi | metode |
| @exception имякласса описание @throws имякласса описание |
Beskrivelse af den undtagelse, der kan kastes fra metoden | metode |
| @deprecated | Beskrivelse af forældede kodeblokke | klasse, interface, felt, metode |
| {@link reference} | Link | klasse, interface, felt, metode |
| {@value} | Beskrivelse af variabel værdi | statisk felt |
Følgende deskriptorer kan bruges til at dokumentere en variabel: @se, @serial, @serialField, {@value}, @deprecated. Deskriptorer kan bruges til klasser og grænseflader: @see, @author, @deprecated, @param, @version. Metoder kan dokumenteres ved hjælp af deskriptorer: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @excertion.
Deskriptorerne {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} kan bruges hvor som helst.
Et eksempel på brug af Javadoc-markering til at dokumentere en metode [2] . Variabeltyper skal ikke angives.
/** * <p>Tjekker om træk er gyldigt.</p> * <p>For at sætte træk til e2-e4, skriv isValidMove(5,2,5,4); * For at optage rokade skal du angive, hvor og hvor kongen flytter fra. * For eksempel, for sort castling skriv isValidMove(5,8,7,8);</p> * * @param fromCol Den lodrette, hvor brikken er placeret (1=a, 8=h) * @param fromRow Den vandrette , hvorpå figuren er placeret (1...8) * @param toCol Den lodrette af cellen, hvorpå bevægelsen foretages (1=a, 8=h) * @param toRow Cellens vandrette, på hvilket træk er lavet (1...8) * @ returner sandt hvis træk er gyldigt, falsk hvis ikke */ boolean isValidMove ( int fromCol , int fromRow , int toCol , int toRow ) { . . . }