Javadoc Comments: IllegalArgumentException deklarieren?

hdi

Top Contributor
Hey,

kurze Frage: Mache ich in einem Javadoc Comment per @throws auf eine IllegalArgumentException aufmerksam? Ich denke eigentlich müsste es reichen wenn man die gültige Range für einen Parameter beim @param dazu schreibt oder? Aber ich hab in der Sun API schon gesehen dass auch unchecked Exceptions da aufgeführt werden, und bin mir jetzt nich sicher ob man das tun sollte oder nicht :bahnhof:

Danke!

edit: ach und wo wir grade dabei sind: Wenn ich extends oder implements habe, dann wird das automatisch rausgezogen aus der Definition und in der Doc angezeigt oder? Oder gibt es dafür auch irgendnen Befehl den ich den den JavaDoc Comment für die Klassendefinition schreiben muss?
 
Zuletzt bearbeitet:

Soahc

Aktives Mitglied
Das mit der IllegalArgumentException kommt darauf an, ob Du sie "thowst".. bei

Java:
/**
	 * Do any thing.
	 *
	 * @param s the s
	 * @throws IllegalArgumentException the illegal argument exception
	 */
	public void doAnyThing(String s) throws IllegalArgumentException {
		if (s.length()==0) throw new IllegalArgumentException("length of s is 0");
		//do...
	}

kommts mit in den JavaDoc und bei

Java:
/**
	 * Do any thing.
	 *
	 * @param s the s
	 */
	public void doAnyThing(String s) {
		if (s.length()==0) throw new IllegalArgumentException("length of s is 0");
		//do...
	}

nicht.
Bei Methoden, die ein Interface implementieren, kommt der Java-Doc in das Interface. Was Du mit Vererbung (extends) meinst, weiß ich jetzt leider nicht. Falls Du mit eclipse arbeitest kann ich Dir auf jeden Fall JAutodoc (JAutodoc - Eclipse Plugin) empfelen... damit kannst Du die korrekten Java-Doc Kommentar-Hüllen jeder Zeit automatisch in deinen Java-Dateien generieren lassen.

gruß, Soahc
 

tfa

Top Contributor
Selbstverständlich kommt die Exception auch in die Java-Docs, wenn man sie nicht explizit deklariert (was bei unchecked nicht nötig, aber möglich ist). Dafür ist doch die Dokumentation da.
 

Marco13

Top Contributor
Man könnte da IMHO auch pragmatisch sein: Wenn man bei @param Dazu schreibt: "The length of the string may not be 0" (oder so), dann bedeutet das IMHO: Wenn die länge 0 ist, ist das Verhalten unpsezifiziert - d.h. da kann "irgendeine" unchecked Exception fliegen, von NPE über AIOOBE bis IAE. Aber wenn man explizit überprüft, und das Teil des Vertrages sein soll, kan man auch dazuschreiben, welche es ist.
 
Ähnliche Java Themen
  Titel Forum Antworten Datum
MiMa Was sollte man ins JavaDoc implementieren?? Allgemeine Java-Themen 17
K JDK installieren JavaDoc hinzufügen Allgemeine Java-Themen 10
R Probleme mit Javadoc Allgemeine Java-Themen 2
V Javadoc-Tags Allgemeine Java-Themen 2
S Javadoc hört einfach auf Allgemeine Java-Themen 4
W JavaDoc Runtime-Exceptions: Wie sinnvoll anzeigen? Allgemeine Java-Themen 14
S javadoc java.lang.NullPointerException Allgemeine Java-Themen 2
D Javadoc - API-Dokumentation Allgemeine Java-Themen 2
J Eclipse Javadoc mit Eclipse erstellen Allgemeine Java-Themen 10
P javadoc als pdf Allgemeine Java-Themen 3
B javadoc, 2 sprachig Allgemeine Java-Themen 3
S Javadoc 3d einbinden macht probleme Allgemeine Java-Themen 10
DEvent Wieso ist Javadoc mit Html Tags? Allgemeine Java-Themen 47
X Javadoc Allgemeine Java-Themen 10
J Eclipse JavaDoc Template Allgemeine Java-Themen 16
P JavaDoc und Backslashes: "Invalid unicode" Allgemeine Java-Themen 3
C eine eigene Javadoc erstelen Allgemeine Java-Themen 3
S JavaDoc aus .class Datei extrahieren Allgemeine Java-Themen 5
M Javadoc | Javadoc Eintrag des verlinkten Element einbetten? Allgemeine Java-Themen 4
M Ant & javadoc-Task Allgemeine Java-Themen 1
G JavaDoc: Spezielle Beschreibung nur in Method Detail Allgemeine Java-Themen 5
Schandro Annotation vs Javadoc bei Konstanten Allgemeine Java-Themen 2
G Javadoc Sichtbarkeiten Allgemeine Java-Themen 3
B JavaDoc auf deutsch? Allgemeine Java-Themen 8
G javadoc fehler bei rawtypes Allgemeine Java-Themen 3
S javadoc inheritDoc funktioniert nicht Allgemeine Java-Themen 6
D javadoc interface + implementation + @overrides Allgemeine Java-Themen 16
S Javadoc einbinden Allgemeine Java-Themen 8
T JAR mit embedded Source/JavaDoc? Allgemeine Java-Themen 8
H Frage zu JavaDoc Allgemeine Java-Themen 5
V javadoc mergen / aus mehreren eclipse plugins ein javadoc Allgemeine Java-Themen 3
T JavaDoc Allgemeine Java-Themen 2
G Javadoc generiert keine Links zu java.lang Klassen? Allgemeine Java-Themen 4
G Bilder in javadoc einbinden Allgemeine Java-Themen 5
Y Javadoc - Wie Parameter ansprechen bei Methodenkommentar Allgemeine Java-Themen 2
F Javadoc: @value tag nicht für private fields? Allgemeine Java-Themen 11
G Javadoc Zeilenumbruch Allgemeine Java-Themen 2
N Javadoc in Deutsch? Allgemeine Java-Themen 9
@ Javadoc: Kurzbeschreibung Packages Allgemeine Java-Themen 10
F Linguistische Fragen zu Javadoc bzw. Englisch Allgemeine Java-Themen 4
padde479 javadoc.exe Eclipse Allgemeine Java-Themen 3
G javadoc macht probleme Allgemeine Java-Themen 2
T Konstruktoren werden nicht in Javadoc angezeigt Allgemeine Java-Themen 2
T Über Javadoc hinausgehende Doku? Allgemeine Java-Themen 4
M Wie lädt Eclipse die Javadoc Allgemeine Java-Themen 14
K Javadoc, was gehört rein? Allgemeine Java-Themen 10
Redfrettchen Javadoc unter Eclipse Allgemeine Java-Themen 2
T Javadoc deutsch? Allgemeine Java-Themen 5
G CSS für Javadoc Allgemeine Java-Themen 2
C javadoc Allgemeine Java-Themen 4
P Javadoc -> Autmatisiertes @version Tag Allgemeine Java-Themen 6
S javadoc: package problem Allgemeine Java-Themen 3
A Javadoc erzeugen Allgemeine Java-Themen 4
G javadoc, pakete Allgemeine Java-Themen 3
M JavaDoc per Batch? Allgemeine Java-Themen 7
I Probleme mit Javadoc (5.0 RC) Allgemeine Java-Themen 6
B Wie sehen gute JavaDoc-Kommentare aus? Allgemeine Java-Themen 10
V Javadoc ertellt keine korrekten links Allgemeine Java-Themen 3
chik JavaDoc als PDF oder RTF Allgemeine Java-Themen 3
S Access Restrictions in Eclipse auf Code beschraenken (und nicht fuer Comments) Allgemeine Java-Themen 2
M IllegalArgumentException Allgemeine Java-Themen 9
MiMa IllegalArgumentException Allgemeine Java-Themen 4
T komplizierter Comparator (IllegalArgumentException) Allgemeine Java-Themen 3
VfL_Freak IllegalArgumentException beim Obfuskieren mit ProGuard V4.4 Allgemeine Java-Themen 6
faetzminator IllegalArgumentException bei Method.invoke() Allgemeine Java-Themen 6
M IllegalArgumentException oder Exception werfen? Allgemeine Java-Themen 18
B Null- oder IllegalArgumentException Allgemeine Java-Themen 12

Ähnliche Java Themen

Neue Themen


Oben