Javadoc richtig benutzen bzw. verwenden

...komplette Frage anzeigen

2 Antworten

Meinst Du, wie Du die Javadoc lesen sollst? Ich persönlich habe keine festgelegte Vorgehensweise, weil je nach Framework die Javadoc mehr oder weniger gut gepflegt ist. Bei einer guten Javadoc macht es meiner Meinung nach Sinn, sich zunächst die Dokumentation der einzelnen Packages anzusehen. Danach weißt Du, was die verschiedenen Teile des Produkts machen. Und erst dann gehe ich im konkreten Fall bis auf Klassenebene und schau mir an, welche Klassen und Methoden wie funktionieren.

Falls es in der Form gemeint sein sollte, wie man Kommentare selbst in seiner Programme einbaut:

Nutze dazu die Referenzdokumentation von Java! Während Du sie benutzt werden Dir grundlegende Fehler bzw. Versäumnisse der Erzeuger auffallen, allen voran der Umstand, daß diese Leute in den meisten Fällen nur Trivialitäten - Dinge, die aus dem Stehgreif unmittelbar aus der formalen Schnittstellendefinition ablesbar sind - in ihre Javadocs geschrieben haben. Mit denen man sich also im wahrsten Sinne des Wortes den Hintern abwischen kann.

In Kommentare gehören die IDEEN (zum Himmeldonnerwetter!) der Programme und Schnittstellen beschrieben, nicht die formellen Selbstverständlichkeiten!

Dazu gehört unter anderem bei Schnittstellen:

  • Wozu die Parameter da sind (welche Bedeutung sie für die Funktion im inneren des Pakets hinter der Schnittstelle haben)
  • Welchen Sinn die Funktion der Schnittstelle für den Anwender haben soll, gegebenenfalls deren Sinn innerhalb eines größeren umschließenden Bibliotheks-Pakets

Was möchtest Du wissen?