Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

--- projektewise17:haligali:notes [2018/01/09 13:56]
zerbian
+++ projektewise17:haligali:notes [2018/01/29 02:09] (aktuell)
d.golovko [Code]
@@ Zeile 2: / Zeile 2: @@
 {{ :projektewise17:haligali:curcuit_diagram.png?300 |}}
+=====Code=====
+{{:projektewise17:haligali:halligalli_code.zip|}}
+===Kommentar zum Code===
+Sehr gut, ihr habt an den meisten Stellen den Code verständlich kommentiert. Man könnte noch zur Box-Klasse eine Beschreibung hinzufügen, was ein Box repräsentiert. Generell in Java werden die Kommentare vor den Methoden so gemacht:
+<code java>
+/**
+ * Erklaerung, was die Methode macht
+ * @param myArgument - Erklaerung zum Argument
+ * @return - Erklaerung, was zurueckgegeben wird
+ */
+public int myMethod(int myArgument) {
+    // macht was
+    return 0; // gibt was zurueck
+}
+</code>
+Mit Hilfe von solchen Kommentaren kann man in einem "normalen" Java-Projekt automatisch die Dokumentation generieren lassen (Stichwort: javadoc).  \\
+Im Rahmen des Robotiklabors (in Processing) ist es in Ordnung, wenn ihr die Methoden einfach mit
+<code java>
+// mein Kommentar
+</code>
+kommentiert -- ich wollte euch aber auch die andere Variante zeigen.

Projektlabor Robotik MINTgrün