Die Präsentation wird geladen. Bitte warten

Die Präsentation wird geladen. Bitte warten

© 2004 Pohlig - Taulien Dokumentation mit JavaDoc.

Ähnliche Präsentationen


Präsentation zum Thema: "© 2004 Pohlig - Taulien Dokumentation mit JavaDoc."—  Präsentation transkript:

1 © 2004 Pohlig - Taulien Dokumentation mit JavaDoc

2 © 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 */

3 © 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 mit @ – kann man die Gestaltung der Dokumentation steuern.

4 © 2004 Pohlig - Taulien GK Informatik mit Java 4 Beispiel /** * @version 2.0 Februar 2004 * @author Michael Pohlig. * Diese Klasse stellt eine Reihe mathematischer * Werkzeuge * zur Verfügung */ public class Mathematik { /** * @param a Koeffizient des quadratischen Glieds * @param b Koeffizient des linearen Glieds * @param c absolutes Glied * @return 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){

5 © 2004 Pohlig - Taulien GK Informatik mit Java 5 einige Schalter von JavaDoc @author Textfügt den Namen des Autors hinzu. @version Textfügt die Versions-Nummer hinzu. @param Parameter Beschreibungfügt Informationen über die Parameter eines Konstruktors oder Methode hinzu. @return Beschreibungfügt Informationen über den Rückgabewert einer Methode hinzu.

6 © 2004 Pohlig - Taulien GK Informatik mit Java 6 Dokumentationen mit JavaEdit Einige Schalter wie @author und @version müssen besonders angegeben werden.

7 © 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.

8 © 2004 Pohlig - Taulien GK Informatik mit Java 8 Dokumentationen mit JavaEdit Mit Start/JavaDoc wird die Dokumentation erstellt und automatisch angezeigt.

9 © 2004 Pohlig - Taulien GK Informatik mit Java 9 Dokumentationen mit JavaEdit


Herunterladen ppt "© 2004 Pohlig - Taulien Dokumentation mit JavaDoc."

Ähnliche Präsentationen


Google-Anzeigen