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

Aus Informatik-Box
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „{{Navigation/Lernpfad|Mit Objektreferenzen arbeiten|GUIs mit dem Java-Editor}}“)
 
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
{{Navigation/Lernpfad|Mit Objektreferenzen arbeiten|GUIs mit dem Java-Editor}}
{{Navigation/Lernpfad|Mit Objektreferenzen arbeiten|GUIs mit dem Java-Editor}}
== Klassendokumentation mit Javadoc ==
<syntaxhighlight lang="java" line="1">
/**
* Eine Klasse, die einen Motorroller repräsentiert.
* @author J. Neugebauer
* @version 2018-05-05
*/
public class Motorroller {
private int tankfuellung = 0;
/**
* Tankt den Roller auf.
* @param pMenge Die zu tankende Menge in Litern.
*/
public void tanken( int pMenge ) {
tankfuellung = tankfuellung + pMenge;
}
/**
* Getter für den Tankinhalt.
* @return Der aktuelle Tankinhalt in Litern.
*/
public int getTankfuellung() {
return tankfuellung;
}
}
</syntaxhighlight>

Version vom 5. Mai 2018, 22:01 Uhr

Klassendokumentation mit Javadoc

/**
 * Eine Klasse, die einen Motorroller repräsentiert.
 * @author J. Neugebauer
 * @version 2018-05-05
 */
public class Motorroller {
	
	private int tankfuellung = 0;

	/**
	 * Tankt den Roller auf.
	 * @param pMenge Die zu tankende Menge in Litern.
	 */
	public void tanken( int pMenge ) {
		tankfuellung = tankfuellung + pMenge;
	}

	/**
	 * Getter für den Tankinhalt.
	 * @return Der aktuelle Tankinhalt in Litern.
	 */
	public int getTankfuellung() {
		return tankfuellung;
	}
}