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

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

Version vom 8. Februar 2022, 15:42 Uhr

115 Bytes entfernt , 15:42, 8. Feb. 2022

keine Bearbeitungszusammenfassung

Jneug

8.581

Bearbeitungen

@@ Zeile 1: / Zeile 1: @@
 {{Navigation}}
 == 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:
+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], [https://www.jetbrains.com/de-de/idea/download IntelliJ], [https://vscodium.com/ Visual Studio Code], [http://www.eclipse.org Eclipse], [http://www.netbeans.org NetBeans]) erkennen die Dokumentation und zeigen sie direkt im Programm an. Zum Teil erlauben sie auch das Durchsuchen der Kommentare.
+* Gängige Programmierumgebungen (wie z.B. {{BlueJ|link}}, {{IntelliJ|link}}, {{VSCode|link}}, {{Eclipse|link}}, {{NetBeans|link}}) 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].
+werden kann. Prominentestes Beispiel ist [https://link.ngb.schule/javaapi die offizielle Java API-Dokumentation].
 == Aufbau eines JavaDoc Kommentars ==
@@ Zeile 42: / Zeile 43: @@
 </syntaxhighlight>
-Es gibt viele Verschiedene Eigenschaften, die zum Teil nur für Klassen oder Methoden erlaubt sind. Zum
+Es gibt viele verschiedene Eigenschaften, die zum Teil nur für Klassen oder Methoden erlaubt sind. Zum
-Beispiel macht es keinen Sinn, die <code>@param</code>-Eigenschaft für die Dokumentation von Klassen
+Beispiel ergibt es wenig Sinn, die <code>@param</code>-Eigenschaft für die Dokumentation von Klassen
 zu verwenden (da sie einen Parameter einer Methode beschreibt).
@@ Zeile 53: / Zeile 54: @@
 : Beispiel: <code>@author Ngb, Smr, Dop</code>
 ; <code>@version</code>
-: Legt die Version der Klasse fest. Maximal einmal pro Klasse oder Interface verwenden. Die Version wird entweder über ein Datum festgelegt, oder über eine Versionsnummer. Für Versionsnummern gibt es keinen einheitlichen Standard, weit verbreitet ist aber das [https://semver.org Semantic Versioning].
+: Legt die Version der Klasse fest. Maximal einmal pro Klasse oder Interface verwenden. Die Version wird entweder über ein Datum festgelegt, oder über eine Versionsnummer. Für Versionsnummern gibt es keinen einheitlichen Standard, weitverbreitet ist aber das [https://semver.org Semantic Versioning].
 : Beispiel: <code>@version 2018-05-20</code>
 : Beispiel: <code>@version 1.0.1</code>
@@ Zeile 126: / Zeile 127: @@
 == HTML-Dokumentation und Javadoc in BlueJ ==
-Javadoc ist nicht nur ein Format für Kommentare, sondern auch ein Programm, dass einen Ordner mit Quelltexten nimmt, und aus den Inhalten eine HTML-Seite generiert, die die Dokumentation der Klassen darstellt. Die Dokumentation zur <code>Wuerfel</code> Klasse oben sieht dann etwa so aus:
+JavaDoc ist nicht nur ein Format für Kommentare, sondern auch ein Programm, dass einen Ordner mit Quelltexten nimmt, und aus den Inhalten eine HTML-Seite generiert, die die Dokumentation der Klassen darstellt. Die Dokumentation zur <code>Wuerfel</code> Klasse oben sieht dann etwa so aus:
 [[Datei:BlueJ Javadoc.jpg|thumb|center|Beispiel einer Javadoc-Dokumentation in BlueJ.]]
-BlueJ integriert die Javadoc-Dokumentation direkt in das Editor-Fenster. Oben rechts kann zwischen den Ansichten ''Quelltext'' und ''Dokumentation'' umgeschaltet werden. Die Dokumentation wird dann direkt aus den Kommentaren im Quelltext generiert und angezeigt.
+BlueJ integriert die JavaDoc-Dokumentation direkt in das Editor-Fenster. Oben rechts kann zwischen den Ansichten ''Quelltext'' und ''Dokumentation'' umgeschaltet werden. Die Dokumentation wird dann direkt aus den Kommentaren im Quelltext generiert und angezeigt.
 [[Datei:BlueJ Editor.jpg|480px|center|BlueJ Editor-Fenster.]]