Javadoc är en API dokument generator som följer med Java 2 SDK och har skapats av Sun Microsystems. Dokumentationen skapas i HTML format, vilket gör att alla kan läsa det.[1]
I Javadoc ingår det även några andra användbara verktyg som underlättar dokumentationen av java koden:

  • Doclet API
  • Taglet API
  • MIF Doclet
  • DocCheck Doclet
  • Exclude Doclet
  • Doclet Toolkit


Kommentera koden

edit

För att skapa grundläggande dokumentation behöver lägga in denna kommentar i java koden.

/**
* Beskrivning av funktion eller klass.
*
* @param parameternamn följt av beskrivning av parameter.
*
* @return följt av förklaring av vad som returneras.
*/

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 med den aktuella hastigheten.
     *
     * @return funktionen returneran hur lång bromssträcka bilen har.
     *
     */
    public int beräknaBromsSträcka(){
       ...
    }

}



Resultatet


Externa Länkar

edit