1 / 9

Dokumentation mit JavaDoc

Dokumentation mit JavaDoc. 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 */

blithe
Download Presentation

Dokumentation mit JavaDoc

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Dokumentationmit JavaDoc

  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 */ 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. GK Informatik mit Java

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

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

  6. Dokumentationen mit JavaEdit Einige Schalter wie @author und @version müssen besonders angegeben werden. 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. GK Informatik mit Java

  8. Dokumentationen mit JavaEdit Mit Start/JavaDoc wird die Dokumentation erstellt und automatisch angezeigt. GK Informatik mit Java

  9. Dokumentationen mit JavaEdit GK Informatik mit Java

More Related