Exceptions dokumentieren.

[proger333]

muss Exceptions die eventuell im Programm auftreten in einer Datei dokumentieren. Gibt es in Java dafür spezielle Mechanismen? oder muss ich das Rad neu erfinden.

gruß Ben

 

[Guest]

Schreibe eine kurze Beschreibung als Javadoc-Kommentar. Die Exceptionklasse selbst wird so kommentiert, wie jede andere Klasse.
z.B.

/**
* Speichert die Daten der gegebenen Person.
* ... mehr Details darüber, was gespeichert wird (Neuanlegen oder Update etc.)
*
* @param person Zu speichernde Person
* @throws DAOException Beschreibung der Exception hierher.
*/
public void speichern(Person person) throws DAOException;

 

[JPKI]

Log4j oder das hier.

 

[Guest]

Noch etwas. Sind es mehrere Exceptions, die von einer Methode geworfen werden können, dann einfach untereinander auflisten.
z.B.

/**
* ...
*
* @throws IOException ...
* @throws NochEineException ...
*/

 

[SlaterB]

ist gut gast, es geht nicht um Java-Doc

 

[Guest]

ist gut gast, es geht nicht um Java-Doc

Tatsächlich. :shock::autsch: Musste aber gesagt werden. :wink:

 

[proger333]

DANKE <JPKI>

gute Docu findet man unter: http://tutego.com/go/logging


gruß Ben