Utilisation des blocs de commentaires#

Using Comment Blocks

Ce tutoriel explique comment utiliser les blocs de commentaires dans VEXcode GO. À la fin, vous saurez pourquoi et comment utiliser les commentaires pour documenter un projet.

Les blocs Commentaires vous permettent d’ajouter des notes directement dans votre pile de blocs, accessible depuis la catégorie Logique - Commentaires de la boîte à outils. Ils n’affectent pas le fonctionnement de votre projet ; ils servent uniquement à faciliter sa compréhension.

Le bloc de commentaires par défaut, ci-dessous, au démarrage.#
au démarrage :: hat events
[comment]

Les programmeurs utilisent des commentaires pour organiser leur code et le rendre plus lisible et compréhensible, aussi bien pour eux-mêmes lorsqu’ils reprennent le projet ultérieurement que pour les autres personnes qui y travaillent. Le nom d’un bloc ne décrit que ce bloc, tandis qu’un commentaire peut décrire le comportement de toute une section de blocs en une seule fois ; ainsi, on peut comprendre d’un coup d’œil ce que fait un ensemble de blocs, sans avoir à lire chaque bloc individuellement.

Par exemple, ce projet avance jusqu’à rencontrer un obstacle, puis fait marche arrière. Tel qu’il est rédigé, il est nécessaire de lire chaque bloc pour le comprendre.

Un projet qui avance jusqu’à rencontrer un obstacle, puis qui fait marche arrière.#
au démarrage :: hat events
se déplacer en [avant v]
attendre jusqu'à <appui sur [bumper v] ? :: custom-led>
arrêter le déplacement
se déplacer [en arrière v] sur (100) [mm v] ▶

L’ajout d’un commentaire au-dessus de chaque section décrit son fonctionnement, ce qui permet de comprendre le projet en un coup d’œil.

Le même projet, avec des commentaires décrivant le comportement de chaque section.#
au démarrage :: hat events
[Drive forward until something is in the way.]
se déplacer en [avant v]
attendre jusqu'à <appui sur [bumper v] ? :: custom-led>
[Back away from the object.]
arrêter le déplacement
se déplacer [en arrière v] sur (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.

Capture d'écran de la barre d'outils VEXcode GO, avec le bouton Démarrer mis en évidence.