Ist das javadoc konform?

Status
Nicht offen für weitere Antworten.

Bierhumpen

Bekanntes Mitglied
Code:
/**
* Datei: Batterie.java
* @version: 1.0
* @author: Ich
* Datum: 06.01.06
*/

/**
*Die Batterieklasse ist dazu da um eine neue Batterie zu erzeugen, die die 
*Moeglichkeit hat sich zu entladen. Bei jeder Bewegung wird ein wenig Energie
*abgezogen.
*/
public class Batterie {

    private int prozent;

    /**
    *Das Objekt Batterie wird hier erzeugt und bekommt zu Beginn einen Ladezu-
    *stand zugewiesen
    *@param ladezustand Ursprungsladezustand einer erzeugten Batterie
    *                   (int) (Standartwert 100)
    */
    Batterie (int ladezustand){
        prozent = ladezustand;
    }

    /**
    *Methode um den aktuell verbrauchten Energiewert von der Restenergie in
    *der Batterie abzuziehen
    *@param prozent Verbrauchsleistung in Prozent (int)
    */
    void verbrauche(int prozent){
        this.prozent = this.prozent - prozent;
    }
    
    /**
    *Methode zum Aufruf des aktuellen Ladungzustandes in %
    *@return prozent Liefert den Ladungszusatnd in % zurueck (int)
    */
    int getProzent(){
        return prozent;
    }

}

Der schmeisst nach der JavaDoc-"kompilierung" nur mist raus... also keine infos zu den einzelnen Methoden und so
 

SnooP

Top Contributor
Wobei ich es halt weniger sinnig finde nen Javadoc zu generieren von privaten Methoden... - javadoc ist ja im Wesentlichen da, dass andere Methoden deiner Klasse nutzen müssen und daher ne Doku brauchen, um zu gucken, was man damit alles machen kann... - die privaten Methoden können sie aber eh nicht nutzen - daher ist eine Dokumentation auch unnötig...

und vom Gebrauch von package-private würde ich auch eher abraten... bei mir ist alles immer entweder public oder private... - oder halt protected... aber nicht dieses Mischdings... - kann man in uml auch nicht ausdrücken und ist von daher doof ;)
 
Status
Nicht offen für weitere Antworten.
Ähnliche Java Themen
  Titel Forum Antworten Datum
W Javadoc HTML erzeugen mit allen dependency Java Basics - Anfänger-Themen 11
S Ich verstehe die RegEx Tabelle von Javadoc nicht so ganz Java Basics - Anfänger-Themen 3
O JavaDoc-Methoden kommentieren Java Basics - Anfänger-Themen 26
Tommy135 Erste Schritte JavaDoc Sortieren Java Basics - Anfänger-Themen 5
M Java Bibliothek Javadoc not found Java Basics - Anfänger-Themen 1
MiMa JavaDoc Exception @throws schlagen an Java Basics - Anfänger-Themen 4
Spencer Reid JavaDoc zu JavaFx hinzufügen Java Basics - Anfänger-Themen 1
O Javadoc bei abstrakten Methoden Java Basics - Anfänger-Themen 1
T Javadoc in Eclipse generieren Java Basics - Anfänger-Themen 1
K Wie in einer Javadoc zurechtfinden Java Basics - Anfänger-Themen 0
K Javadoc-Erstellung Java Basics - Anfänger-Themen 16
MiMa JavaDoc Kommentare Java Basics - Anfänger-Themen 12
B Javadoc richtig lesen... Java Basics - Anfänger-Themen 4
B Erste Schritte Javadoc Tool Java Basics - Anfänger-Themen 7
D Javadoc für Packages oder ganze Projekte Java Basics - Anfänger-Themen 5
B Javadoc-Befehl unter Ubuntu Java Basics - Anfänger-Themen 2
D javadoc: wie werden Umlaute richtig dargestellt? Java Basics - Anfänger-Themen 3
D javadoc Java Basics - Anfänger-Themen 5
D Libarie und Javadoc in Netbeans einbinden? Java Basics - Anfänger-Themen 6
H Javadoc Warnungen/Fehlermeldung Java Basics - Anfänger-Themen 2
J Javadoc -> Mehrere Klassen Java Basics - Anfänger-Themen 8
I Javadoc in Eclipse Java Basics - Anfänger-Themen 14
alderwaran closed source jar, kein javadoc. was macht methode x eigentlich? ( oracle forms pjc beans ) Java Basics - Anfänger-Themen 2
B [Javadoc] Tutorial für die Auswertung des docs Java Basics - Anfänger-Themen 15
C JavaDoc Problem Java Basics - Anfänger-Themen 4
J Tools für Java-Konvention und Javadoc ? Java Basics - Anfänger-Themen 2
Private Void JavaDoc Java Basics - Anfänger-Themen 2
J Javadoc Java Basics - Anfänger-Themen 6
S javadoc herunterladen Java Basics - Anfänger-Themen 2
G Mit Javadoc arbeiten Java Basics - Anfänger-Themen 13
M Javadoc generieren Java Basics - Anfänger-Themen 4
A Javadoc erstellen aus Klassen verteilt in Unterordnern Java Basics - Anfänger-Themen 4
K javadoc eigenes doclet in console starten Java Basics - Anfänger-Themen 3
K import com.sun.javadoc.*; gibts nicht Java Basics - Anfänger-Themen 1
S Problem beim JavaDoc erstellen. Java Basics - Anfänger-Themen 5
A Javadoc nur bei public Klassen? Java Basics - Anfänger-Themen 3
G Javadoc unter Eclipse Java Basics - Anfänger-Themen 4
G Javadoc Problem nach Neuinstallation Java Basics - Anfänger-Themen 7
K Javadoc problem mit Enum-Klasse Java Basics - Anfänger-Themen 5
B Eclipse + Debian = javadoc? Java Basics - Anfänger-Themen 2
G Javadoc Java Basics - Anfänger-Themen 2
F Javadoc Zugriffsprobleme über Eclipse Java Basics - Anfänger-Themen 2
A Javadoc Java Basics - Anfänger-Themen 3
S javac/javadoc Java Basics - Anfänger-Themen 11
W kann javadoc nicht finden Java Basics - Anfänger-Themen 2
R Javadoc Problem Java Basics - Anfänger-Themen 4
O javadoc Java Basics - Anfänger-Themen 4
C javadoc.exe nicht in JDK enthalten Java Basics - Anfänger-Themen 3
Bierhumpen JavaDoc und Joe Java Basics - Anfänger-Themen 2
G javadoc generieren? Java Basics - Anfänger-Themen 3
R javadoc in eclipse 3.1? Java Basics - Anfänger-Themen 4

Ähnliche Java Themen

Neue Themen


Oben