nogard 5

src/nogard/schritt5/Befehl.java

@@ -1,26 +1,51 @@
-package  nogard.schritt5;
+package nogard.schritt5;
 
+/**
+ * Objekte dieser Klasse halten Informationen <20>ber Befehle, die der Benutzer eingegeben hat. 
+ * 
+ * Ein Befehl besteht momentan aus zwei Zeichenketten: 
+ * - einer ersten Zeichenkette, die das Schl<68>sselwort des Befehls angibt und 
+ * - einer zweiten Zeichenkette, die einen Zusatz zum Befehl enth<74>lt.
+ * 
+ * Beim Befehl "go north" sind die beiden Zeichenketten des Befehls 
+ * - "go" und 
+ * - "north".
+ * 
+ * Wenn der Befehl nur aus einem Schl<68>sselwort besteht, dann ist das zweite Wort 'null'.
+ */
 public class Befehl {
-    private final String befehl_wort;
-    private final String befehl_zusatz;
+	
+    private String befehlsWort;
+    private String befehlsZusatz;
 
-    public Befehl(String wort) {
-        befehl_wort = wort;
-        befehl_zusatz = null;
+    /**
+     * Konstruktor.
+     * @param befehlsWort 		Das Schl<68>sselwort des Befehls. 
+     * 							Sollte 'null' sein, wenn dieser Befehl als nicht vom Spiel erkannt gekennzeichnet werden soll.
+     * @param befehlsZusatz		Der Zusatz des Befehls.
+     * 							Sollte 'null' sein, wenn der Befehl nur aus einem Schl<68>sselwort besteht.
+     */
+    public Befehl(String befehlsWort, String befehlsZusatz) {
+        this.befehlsWort = befehlsWort;
+        this.befehlsZusatz = befehlsZusatz;
     }
 
-    public Befehl(String wort, String zusatz) {
-        befehl_wort = wort;
-        befehl_zusatz = zusatz;
+    /**
+     * Liefert das Schl<68>sselwort des Befehls.
+     * @return Das Schl<68>sselwort des Befehls.
+     */
+    public String getBefehlsWort() {
+        return befehlsWort;
     }
 
-    public String getWort() {
-        return befehl_wort;
+    /**
+     * Liefert den Zusatz zum Befehl.
+     * Wenn es keinen Befehlszusatz gibt, ist das Ergebnis 'null'. 
+     * @return Den Zusatz zum Befehl.
+     */
+    public String getBefehlsZusatz() {
+        return befehlsZusatz;
     }
-
-    public String getZusatz() {
-        return befehl_zusatz;
-    }
-
-
+    
 }
+