© 2004 Pohlig - Taulien Dokumentation mit JavaDoc
© 2004 Pohlig - Taulien GK Informatik mit Java 2 Kommentare in Java // Dieser Kommentar gilt bis zum Zeilenende /* Dieser Kommentar beginnt hier und endet erst, wenn das kommende Zeichen auftritt. Eignet sich auch, um Programmteile auszukommentieren */ /** wie oben, nur mir dem Unterschied, * dass javadoc.exe damit etwas anfangen kann */
© 2004 Pohlig - Taulien GK Informatik mit Java 3 Dokumentations-Kommentare Mit Hilfe von Dokumentations-Kommentaren kann javadoc.exe automatisch HTML-Seiten erzeugen. Sie stehen unmittelbar vor einer Klasse, einem Konstruktor oder einer Methode. Innerhalb des Kommentars sind HTML- Anweisungen erlaubt. Mit Hilfe von speziellen Schaltern –sie beginnen – kann man die Gestaltung der Dokumentation steuern.
© 2004 Pohlig - Taulien GK Informatik mit Java 4 Beispiel /** 2.0 Februar 2004 Michael Pohlig. * Diese Klasse stellt eine Reihe mathematischer * Werkzeuge * zur Verfügung */ public class Mathematik { /** a Koeffizient des quadratischen Glieds b Koeffizient des linearen Glieds c absolutes Glied Lösungen bzw. Lösungsmengen der * quadratischen Gleichung ax^2 + bx +c =0 */ public static String loeseQuadGl(double a, double b, double c){ if (a==0){ if (b==0){
© 2004 Pohlig - Taulien GK Informatik mit Java 5 einige Schalter von Textfügt den Namen des Autors Textfügt die Versions-Nummer Parameter Beschreibungfügt Informationen über die Parameter eines Konstruktors oder Methode Beschreibungfügt Informationen über den Rückgabewert einer Methode hinzu.
© 2004 Pohlig - Taulien GK Informatik mit Java 6 Dokumentationen mit JavaEdit Einige Schalter müssen besonders angegeben werden.
© 2004 Pohlig - Taulien GK Informatik mit Java 7 Dokumentationen mit JavaEdit Sämtliche Dateien, die in die Dokumentation mit einbezogen werden sollen, müssen in JavaEdit geöffnet sein.
© 2004 Pohlig - Taulien GK Informatik mit Java 8 Dokumentationen mit JavaEdit Mit Start/JavaDoc wird die Dokumentation erstellt und automatisch angezeigt.
© 2004 Pohlig - Taulien GK Informatik mit Java 9 Dokumentationen mit JavaEdit