| javadoc | |
|---|---|
| Sorts | Dokumentationsgenerator |
| Utvecklaren | Sun Microsystems |
| Operativ system | plattformsoberoende |
| Hårdvaruplattform | Java Virtual Machine |
| senaste versionen | 1,50 |
| Licens | GNU GPL 2 + "Classpath undantag" [1] |
| Hemsida | docs.oracle.com/javase/8... |
Javadoc är en HTML - dokumentationsgenerator från Sun Microsystems Java - källkodskommentarer . Javadoc är en standard för att dokumentera Java - klasser . De flesta mjukvaruutvecklingsmiljöer genererar automatiskt HTML -dokumentation med hjälp av Javadoc.
Javadoc tillhandahåller också ett API för att skapa doclets och taglets som låter programmeraren analysera strukturen i en Java -applikation.
Dokumentationskommentarer används för:
I varje fall måste kommentaren komma före det dokumenterade elementet.
| Lista över Javadoc- deskriptorer | ||
|---|---|---|
| Beskrivare | Beskrivning | Tillämplig på |
| @author | Författare | klass, gränssnitt |
| @version | Version. Högst en deskriptor per klass | klass, gränssnitt |
| @since | Indikerar vilken version som finns tillgänglig från | klass, gränssnitt, fält, metod |
| @see | Länk till annan plats i dokumentationen | klass, gränssnitt, fält, metod |
| @param | Metodinmatningsparameter | metod |
| @return | Beskrivning av returvärde | metod |
| @exception имякласса описание @throws имякласса описание |
Beskrivning av undantaget som kan kastas från metoden | metod |
| @deprecated | Beskrivning av föråldrade kodblock | klass, gränssnitt, fält, metod |
| {@link reference} | Länk | klass, gränssnitt, fält, metod |
| {@value} | Beskrivning av variabelt värde | statiskt fält |
Följande deskriptorer kan användas för att dokumentera en variabel: @se, @serial, @serialField, {@value}, @deprecated. Deskriptorer kan användas för klasser och gränssnitt: @see, @author, @deprecated, @param, @version. Metoder kan dokumenteras med deskriptorer: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @excertion.
Beskrivningarna {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} kan användas var som helst.
Ett exempel på att använda Javadoc-markering för att dokumentera en metod [2] . Variabeltyper behöver inte anges.
/** * <p>Kontrollerar om draget är giltigt.</p> * <p>Till exempel, för att ställa in draget till e2-e4, skriv isValidMove(5,2,5,4); * För att spela in castling, ange var och var kungen flyttar ifrån. * Till exempel, för svart castling skriv isValidMove(5,8,7,8);</p> * * @param fromCol Den vertikala där pjäsen är placerad (1=a, 8=h) * @param fromRow Den horisontella , på vilken figuren finns (1...8) * @param toCol Den vertikala av cellen, på vilken rörelsen görs (1=a, 8=h) * @param toRow Cellens horisontella, på vilket drag görs (1...8) * @ return true om draget är giltigt, false om inte */ boolean isValidMove ( int fromCol , int fromRow , int toCol , int toRow ) { . . . }