Verwendung von Kommentarblöcken#

Using Comment Blocks

Dieses Tutorial erklärt die Verwendung von Kommentarblöcken in VEXcode GO. Am Ende wissen Sie, warum und wie Sie Kommentare zur Projektdokumentation einsetzen.

Mit Kommentarblöcken können Sie direkt in Ihren Blockstapel, den Sie in der Kategorie Logik – Kommentare in der Werkzeugkiste finden, Notizen hinzufügen. Sie haben keinen Einfluss auf die Ausführung Ihres Projekts – sie dienen lediglich dazu, Ihnen und anderen das Verständnis zu erleichtern.

Der standardmäßige Kommentarblock, der beim Start unten angezeigt wird.#
wenn gestartet :: hat events
[comment]

Programmierer verwenden Kommentare, um ihren Code zu strukturieren und ihn lesbarer und verständlicher zu machen – sowohl für sich selbst, wenn sie später an einem Projekt weiterarbeiten, als auch für andere, die daran arbeiten. Der Name eines einzelnen Blocks beschreibt nur diesen einen Block, aber ein Kommentar kann das Verhalten eines ganzen Blockabschnitts auf einmal beschreiben – so lässt sich die Funktion eines Blockstapels auf einen Blick erfassen, ohne jeden einzelnen Block lesen zu müssen.

Dieses Projekt beispielsweise schreitet voran, bis es auf ein Hindernis stößt und dann einen Rückzieher macht. Um das zu verstehen, muss man, wie es geschrieben steht, jeden einzelnen Abschnitt durchlesen.

Ein Projekt, das so lange fährt, bis es auf etwas stößt, und dann einen Rückzieher macht.#
wenn gestartet :: hat events
fahre [vorwärts v]
warte bis <[bumper v] gedrückt? :: custom-led>
Fahren stoppen
fahre [rückwärts v] für (100) [mm v] ▶

Durch das Hinzufügen eines Kommentars über jedem Abschnitt wird dessen Verhalten beschrieben, wodurch das Projekt auf einen Blick leichter verständlich wird.

Das gleiche Projekt, mit Kommentaren, die das Verhalten der einzelnen Abschnitte beschreiben.#
wenn gestartet :: hat events
[Drive forward until something is in the way.]
fahre [vorwärts v]
warte bis <[bumper v] gedrückt? :: custom-led>
[Back away from the object.]
Fahren stoppen
fahre [rückwärts v] für (100) [mm v] ▶

After connecting your robot to VEXcode, select Start to run the project. The robot will drive forward, stop and back away once it bumps into something.

Screenshot der VEXcode GO-Symbolleiste, wobei die Schaltfläche „Start“ hervorgehoben ist.