Benutzer-Werkzeuge

Webseiten-Werkzeuge


Seitenleiste

projektewise17:haligali:notes

Schaltplan

Code

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:

/**
 * 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
}

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

// mein Kommentar

kommentiert – ich wollte euch aber auch die andere Variante zeigen.

projektewise17/haligali/notes.txt · Zuletzt geändert: 2018/01/29 02:09 von d.golovko