Lernpfad:Würfelspiel in Java/Klassendokumentation mit Javadoc - Versionsgeschichte

Jneug am 8. Februar 2022 um 13:48 Uhr

2022-02-08T13:48:52Z

← Nächstältere Version		Version vom 8. Februar 2022, 15:48 Uhr
Zeile 9:		Zeile 9:
	* Der eigene Quelltext wird lesbarer und lässt sich auch nach längerer Zeit nachvollziehen.		* Der eigene Quelltext wird lesbarer und lässt sich auch nach längerer Zeit nachvollziehen.
	* 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.		* 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		* 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/javaapi die offizielle Java API-Dokumentation].
	werden kann. Prominentestes Beispiel ist [https://link.ngb.schule/javaapi die offizielle Java API-Dokumentation].

	== Aufbau eines JavaDoc Kommentars ==		== Aufbau eines JavaDoc Kommentars ==

Jneug am 8. Februar 2022 um 13:42 Uhr

2022-02-08T13:42:02Z

Jneug: /* Klassendokumentation mit Javadoc */

2021-11-12T15:14:13Z

Klassendokumentation mit Javadoc

← Nächstältere Version		Version vom 12. November 2021, 17:14 Uhr
Zeile 7:		Zeile 7:
	* Klasse-Dateien lassen sich einfacher weitergeben und verstehen, da sie ihre eigene Dokumentation enthalten.		* 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.		* 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.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. [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.
	* Aus dem Quelltext lässt sich direkt eine HTML-Version der Dokumentation erstellen, die separat vom Quelltext angezeigt		* 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/java8api die offizielle Java API-Dokumentation].

Jneug am 12. November 2021 um 15:11 Uhr

2021-11-12T15:11:11Z

← Nächstältere Version		Version vom 12. November 2021, 17:11 Uhr
Zeile 73:		Zeile 73:
	: Beispiel: <code>Link zur Scanner-Klasse: {@link java.util.Scanner}</code>		: Beispiel: <code>Link zur Scanner-Klasse: {@link java.util.Scanner}</code>

	{{~~Hint~~:Start}}		{{Info:Start}}
	Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>.		Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>.
	{{~~Hint~~:End}}		{{Info:End}}

	== Beispiel einer Klasse mit Dokumentation ==		== Beispiel einer Klasse mit Dokumentation ==

Jneug am 29. Juni 2018 um 13:17 Uhr

2018-06-29T13:17:23Z

← Nächstältere Version		Version vom 29. Juni 2018, 15:17 Uhr
Zeile 1:		Zeile 1:
	{{Navigation~~/Lernpfad\|Mit Objektreferenzen arbeiten\|GUIs mit dem Java-Editor~~}}		{{Navigation}}

	== Klassendokumentation mit Javadoc ==		== Klassendokumentation mit Javadoc ==

Jneug: /* HTML-Dokumentation und Javadoc in BlueJ */

2018-05-22T08:26:32Z

HTML-Dokumentation und Javadoc in BlueJ

← Nächstältere Version		Version vom 22. Mai 2018, 10:26 Uhr
Zeile 129:		Zeile 129:
	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\|center\|Beispiel einer Javadoc-Dokumentation in BlueJ]]		[[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.

			[[Datei:BlueJ Editor.jpg\|480px\|center\|BlueJ Editor-Fenster.]]

	== Weitere Informationen ==		== Weitere Informationen ==

Jneug: /* Verwendung in BlueJ */

2018-05-22T08:16:01Z

Verwendung in BlueJ

← Nächstältere Version		Version vom 22. Mai 2018, 10:16 Uhr
Zeile 125:		Zeile 125:
	</syntaxhighlight>		</syntaxhighlight>

	== ~~Verwendung~~ in BlueJ ==		== 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:

			[[Datei:BlueJ Javadoc.jpg\|center\|Beispiel einer Javadoc-Dokumentation in BlueJ]]

	== Weitere Informationen ==		== Weitere Informationen ==

Jneug am 20. Mai 2018 um 06:36 Uhr

2018-05-20T06:36:29Z

← Nächstältere Version		Version vom 20. Mai 2018, 08:36 Uhr
Zeile 124:		Zeile 124:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			== Verwendung in BlueJ ==

	== Weitere Informationen ==		== Weitere Informationen ==

Jneug am 20. Mai 2018 um 06:34 Uhr

2018-05-20T06:34:44Z

← Nächstältere Version		Version vom 20. Mai 2018, 08:34 Uhr
Zeile 77:		Zeile 77:
	Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>.		Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>.
	{{Hint:End}}		{{Hint:End}}

	~~== Ein Vollständiges Beispiel ==~~

	== Beispiel einer Klasse mit Dokumentation ==		== Beispiel einer Klasse mit Dokumentation ==
	<syntaxhighlight lang="java" line="1">		<syntaxhighlight lang="java" line="1">
			import java.util.Random;

	/**		/**
	* Eine Klasse~~, die~~ einen ~~Motorroller repräsentiert~~.		* Eine Klasse um Zufallszahlen zu "würfeln".
	* @author J. Neugebauer		* Die Klasse generiert ganze
			* <a href="https://de.wikipedia.org/wiki/Pseudozufall">Pseudozufallszahlen</a>
			* von 1 bis zu einem vorher festgelegten Maximum. Um einen normalen
			* sechseitigen Würfel zu erzeugen benutzt man:
			* <pre>
			* Wuerfel w = new Wuerfel(6);
			* </pre>
			* Die ZUfallszahlen werden mit Hilfe von {@link java.util.Random} generiert.
			*
			* @author J. Neugebauer <schule@neugebauer.cc>
	* @version 2018-05-05		* @version 2018-05-05
	*/		*/
	public class ~~Motorroller~~ {		public class Wuerfel {

	private int ~~tankfuellung = 0~~;		private int seiten;

			private Random zufall;

	/**		/**
	* ~~Tankt den Roller auf~~.		* Konstruktor für Objekte der Klasse Wuerfel.
	* @param ~~pMenge Die zu tankende Menge in Litern~~.		* @param pSeiten Anzahl der Seiten des Würfels.
	*/		*/
	public ~~void tanken~~( int ~~pMenge~~ ) {		public Wuerfel( int pSeiten ) {
	~~tankfuellung~~ = ~~tankfuellung + pMenge~~;		seiten = pSeiten;
			zufall = new Random();
	}		}

	/**		/**
	* ~~Getter für~~ den ~~Tankinhalt~~.		* "Wirft" den Würfel
	* @return ~~Der aktuelle Tankinhalt in Litern~~.		* Es wird eine Zufallszahl zwischen 1 und dem vorher festgelegten
			* Maximum (einschließlich) generiert.
			* @return Eine Ganzzahl von 1 bis zum Maximum
			* @see java.util.Random#nextInt(int)
	*/		*/
	public int ~~getTankfuellung~~() {		public int werfen() {
	return ~~tankfuellung~~;		// nextInt(int) generiert eine Zufallszahl n mit 0 <= n < 6
			return zufall.nextInt(seiten)+1;
	}		}
	}		}

Jneug: /* Aufbau eines JavaDoc Kommentars */

2018-05-20T06:25:37Z

Aufbau eines JavaDoc Kommentars

← Nächstältere Version		Version vom 20. Mai 2018, 08:25 Uhr
Zeile 77:		Zeile 77:
	Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>.		Einige Eigenschaften wie <code>@see</code> oder <code>@link</code> können auch innerhalb des Langkommentars eingefügt werden. Dann müssen sie innerhalb von geschweiften Klammern stehen. Um zum Beispiel im Kommentar einen Link zur Klasse <code>java.lang.Math</code> einzufügen, schreibt man <code>{@link java.lang.Math}</code>.
	{{Hint:End}}		{{Hint:End}}

			== Ein Vollständiges Beispiel ==

	== Beispiel einer Klasse mit Dokumentation ==		== Beispiel einer Klasse mit Dokumentation ==

← Nächstältere Version		Version vom 8. Februar 2022, 15:42 Uhr
Zeile 1:		Zeile 1:
	{{Navigation}}		{{Navigation}}

	== Klassendokumentation mit Javadoc ==		== Klassendokumentation mit Javadoc ==

	JavaDoc ist ein Format, um die Dokumentation von Klassen, Attributen und Methoden direkt im Quelltext zu verfassen.		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		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.		* 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.		* 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		* 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 ==		== Aufbau eines JavaDoc Kommentars ==
Zeile 42:		Zeile 43:
	</syntaxhighlight>		</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).		zu verwenden (da sie einen Parameter einer Methode beschreibt).

Zeile 53:		Zeile 54:
	: Beispiel: <code>@author Ngb, Smr, Dop</code>		: Beispiel: <code>@author Ngb, Smr, Dop</code>
	; <code>@version</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 2018-05-20</code>
	: Beispiel: <code>@version 1.0.1</code>		: Beispiel: <code>@version 1.0.1</code>
Zeile 126:		Zeile 127:
	== HTML-Dokumentation und Javadoc in BlueJ ==		== 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.]]		[[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.]]		[[Datei:BlueJ Editor.jpg\|480px\|center\|BlueJ Editor-Fenster.]]