lars_wingbermue
I'm new here

Optimierung der Java-API-Dokumentation

Ich erhalte von unseren Java-Entwicklern immer wieder die Rückmeldung, dass die API-Dokumentation der FS-Schnittstelle sehr schlecht beschrieben ist. Um das Thema einmal hier zu platzieren und ggf. auf Feedback von anderen Nutzern einzuholen, eröffne ich einmal eine Diskussion dazu.

Ein Vorschlag wäre es sich die Java-Dokumentation selber als Vorbild zu nehmen.

Ein extremes Beispiel dort ist die String Klasse. Dort ist jede Methode der Klasse exakt beschrieben:

http://docs.oracle.com/javase/7/docs/api/java/lang/String.html

Und als Übersicht die Package Summary: http://docs.oracle.com/javase/7/docs/api/java/lang/package-summary.html

Wie man eine gute API DOC schreibt ist hier beschrieben: http://www.oracle.com/technetwork/articles/java/index-137868.html

Wie wird das bei anderen Nutzern gesehen?

Gibt es dort die selben Probleme bzw. Wünsche?

Wie gehen Sie bei der Entwicklung der Module und Anwendungen vor um das Problem zu minimieren?

10 Replies

Hi Marcel,

Danke für den Hinweis. Das lässt sich jedoch nicht so einfach beheben, denn die referenzierte Klasse SecurityManager ist leider nicht in der API (und soll vermutlich auch nicht dort hin). Das ist wohl eine der etwas "unsauberen" Ecken.

Beste Grüße und frohes 2015,

Stefan

0 Kudos