Lernpfad:Würfelspiel in Java/Klassendokumentation mit Javadoc: Unterschied zwischen den Versionen

Lernpfad:Würfelspiel in Java/Klassendokumentation mit Javadoc (Quelltext anzeigen)

1.000 Bytes hinzugefügt , 12:27, 9. Mai 2018

keine Bearbeitungszusammenfassung

8.581

Bearbeitungen

@@ Zeile 2: / Zeile 2: @@
 == Klassendokumentation mit Javadoc ==
+Javadoc ist ein Format, um die Dokumentation von Klassen, Attributen und Methoden direkt im Quelltext zu verfassen.
+Dadurch ist die Dokumentation einer Methode direkt mit ihrem Quelltext verknüpft. Hält sich ein Programmierer an
+die Vorgaben des Formats, ergeben sich viele Vorteile:
+* Klasse-Dateien lassen sich einfacher weitergeben und verstehen, da sie ihre eigene Dokumentation enthalten.
+* Der eigene Quelltext wird lesbarer und lässt sich auch nach längerer Zeit nachvollziehen.
+* Gängige Programmierumgebungen (wie z.B. [http://www.bluej.org BlueJ], [http://www.eclipse.org Eclipse],
+[http://www.netbeanside.com NetBeans]) erkennen die Dokumentation und zeigen sie direkt im Programm an. Zum
+Teil erlauben sie auch das Durchsuchen der Kommentare.
+* Aus dem Quelltext lässt sich direkt eine HTML-Version der Dokumentation erstellen, die separat vom Quelltext angezeigt
+werden kann. Prominentestes Beispiel ist [https://link.ngb.schule/java8api die offizielle Java API-Dokumentation].
 <syntaxhighlight lang="java" line="1">