JavaDoc Exception @throws schlagen an

[MiMa]

Hallo,

meinen Javacode funktioniert soweit alles ganz gut, nutze auch das Javadoc um den Code übersichtlich mit Informationen zu bestücken.

Nachdem ich jetzt mal wieder das JavaDoc generiert habe, erhalte ich jede Menge Warnings.

Die Fehlermeldung sieht so aus:

warning: no description for @throws
     * @throws java.text.ParseException

Demnach vermutet man, das an dieser Stelle kein Eintrag für ParseException ist und das dieser nötig ist.

Im Code habe ich dann die Verlinkung angeklickt und bin dann direkt dort gelandet.

...  /**
     * Prüft ein Datum auf Echtheit und gibt es zurück <br>
     *
     * @param datum : String (dd.mm.yyyy)
     * @return datumGeprueft : String (dd.mm.yyyy)
     * @throws java.text.ParseException
     */
    public static String pruefeDatum(String datum) throws ParseException { ...

Also wenn ich mir das ansehe, ist der Eintrag doch dort vorhanden?

Warum erhalte ich denn jetzt das warning dazu??

Building index for all the packages and classes...
Building index for all classes...
Generating ...
7 errors
42 warnings
...
BUILD FAILED (total time: 1 second)

Soso, 7 Fehler und 42 Warinings ???
Die 7 Fehler habe ich ziemlich schnell gelöst bekommmen, aber die Warings sagen mir gar nichts?

Es wird bemängelt das die Parameter nicht vorhanden sind! Sind aber doch da?

Weis jemand warum?

Vielen Dank
Mi

 

[kneitzel]

Also bezüglich der 42 Warnungen: Ohne Details, wird Dir da hier niemand helfen können.

Bezüglich @throws sehe ich zwei Optionen:
a) zuordnung der Exception schlägt fehl, weil sie einmal mit Package und einmal ohne geschrieben wurd (unwahrscheinlich)
b) Du dokumentierst ja nichts. Wozu javadocs einfügen, wenn du nichts dokumentierst? @throws exception Beschreibung wann/wieso ist zu schreiben. Daher fehlt bei dir die Beschreibung so wie es in der Warnung genannt wurde.

Das wäre jetzt so am Handy meine Vermutung.

 

[MiMa]

Wenn Du sagst es werden keine @throws dokumentiert, dann macht das auch wieder Sinn.
Die @throws wurden von NetBeans selbst erstellt wenn ich mit /** angefangen und Return bestätigt habe.

Außer den langen Link vor der Meldung wurde auch nichts weiter ausgegeben.
Da ich mit JavaDoc keine Erfahrung habe, werde ich mich jetzt mal damit beschäftigen, um zu wissen, was da hinein kommen muss.

Auf jeden Falll vielen Dank für den Hinweis.
Mi

 

[kneitzel]

Also das, was NetBeans da macht (Ich kenne es nicht, aber IntelliJ hilft ähnlich) ist einfach nur die Bereitstellung eines Rahmens. In diesen musst Du dann die Dokumentation schreiben.

Also müsste da sowas stehen wie:

* @throws java.text.ParseException Wenn der Parameter datum kein gültiges Datum im vorgegebenen Format enthält wird eine ParseException geworfen.

Desweiteren würde ich da generell mehr Text schreiben und nicht einfach nur "@param datum : String (dd.mm.yyyy)" Und die Bedeutung von deinem dd.mm.yyyy würde ich weiter ausführen. Und da Du das Format an mehreren Stellen brauchst, würde ich das in die Beschreibung selbst packen und dann - ähnlich wie ich es bei @throws versucht habe, einfach an allen Stellen von einem vorgegebenen Format sprechen.

Wenn Du Dich intensiv damit beschäftigen möchtest, dann kannst Du Dir auch die generierte Dokumentation ansehen und darüber entscheiden, was Du wie machen willst. Ich nutze es oft einfach nur für eine "In Code" Dokumentation, d.h. es muss im Code gut aussehen und weiter helfen. Daher wird man bei mir keine html Elemente finden wie Dein <br>. (Hier würde ich prüfen, in wie weit ein <br /> nicht besser ist, damit man ein sauberes html erhält, das auch ein gültiges xml Dokument ist.)

Konrad

 

[MiMa]

Danke, hat geholfen