User:A stranger x
Jump to navigation
Jump to search
Javadoc[edit]
Javadoc är ett verktyg som utvecklats av Sun Microsystems för att man enkelt, snabbt och på ett standardiserat sätt ska kunna skapa dokumentation till java projekt. Dokumentationen som fås är i html format vilket gör att kan läsa den, det går även att få ut dokumentation i andra format som till exempel PDF. [1]
Hur javadoc används[edit]
Att använda sig av javadoc är inte svårt. Man ser bara till att kommentera koden på detta sätt:
/**
* Beskrivning av funktion.
*
* @param variabel namn beskrivning av variabel.
*
* @return beskrivning av return värde.
*
* /
Sedan använder man kommandot javadoc följt av filerna man vill dokummentera. Exempel: javadoc Bil.java
Ett exempel[edit]
/**
* Den är klassen beskriver en bil.
*/
public class Bil{
private int hastighet = 0;
private int maxHastighet = 0;
/**
* Standard konstruktor.
*
* @param h anger vad max hastigheten för bilen är.
*
*/
public Bil(int h){
//...
}
/**
* Ändrar bilens hastighet.
*
* @param h bilens nya hastighet.
*
*/
public void ändraHastigheten(int h){
//...
}
/**
* Funktionen räknar ut bilens bromssträcka givet den aktuella hastigheten.
*
* @return funktionen returneran hur lång bromssträcka bilen har.
*
*/
public int beräknaBromsSträcka(){
//...
}
}
Resultat:
Länkar[edit]
- Javadoc tool
- JavaDoc tags och hur man skriver kommentarer
- JSR 260 Javadoc Tag Technology Update Java Specification Request (defines new Javadoc tags)
- Att förbättra Javadocs med ashkelon
- En samling av Javadoc doclets
- Javadoc exempel
- JavadocOnline
- MyJavadoc
- DocJar
- Globaldocs
- Olika Java documentationer konverterade till Windows Help format