Korzystanie z bloków komentarzy#

Using Comment Blocks

W tym samouczku dowiesz się, jak korzystać z bloków komentarzy w VEXcode GO. Dowiesz się, dlaczego i jak używać komentarzy do dokumentowania projektu.

Bloki Komentarze pozwalają dodawać notatki bezpośrednio do stosu bloków, które znajdują się w kategorii Logika – Komentarze w skrzynce narzędziowej. Nie wpływają one na przebieg projektu — służą jedynie do ułatwienia Tobie i innym zrozumienia jego działania.

Poniżej domyślny blok komentarza po uruchomieniu.#
gdy uruchomiony :: hat events
[comment]

Programiści używają komentarzy, aby uporządkować swój kod i ułatwić jego czytanie i zrozumienie, zarówno dla siebie, gdy wracają do projektu później, jak i dla innych osób nad nim pracujących. Nazwa pojedynczego bloku opisuje tylko ten jeden blok, ale komentarz może opisywać działanie całej sekcji bloków naraz – dzięki czemu można zrozumieć działanie stosu bloków na pierwszy rzut oka, bez konieczności czytania każdego z osobna.

Na przykład ten projekt porusza się do przodu, aż wpadnie na coś, a potem się cofa. Zrozumienie tego, tak jak jest napisane, wymaga przeczytania każdego bloku.

Projekt, który działa, dopóki nie natrafi na przeszkodę, a potem się wycofuje.#
gdy uruchomiony :: hat events
jedź [do przodu v]
czekaj dopóki <[bumper v] wciśnięty? :: custom-led>
zatrzymaj jazdę
jedź [wstecz v] przez (100) [mm v] ▶

Dodanie komentarza nad każdą sekcją opisuje jej działanie, dzięki czemu projekt będzie łatwiejszy do zrozumienia na pierwszy rzut oka.

Ten sam projekt z komentarzami opisującymi zachowanie każdej sekcji.#
gdy uruchomiony :: hat events
[Drive forward until something is in the way.]
jedź [do przodu v]
czekaj dopóki <[bumper v] wciśnięty? :: custom-led>
[Back away from the object.]
zatrzymaj jazdę
jedź [wstecz v] przez (100) [mm v] ▶

Po połączeniu robota z VEXcode wybierz Start, aby uruchomić projekt. Robot będzie jechał do przodu, zatrzymywał się i cofał po uderzeniu w coś.

Zrzut ekranu paska narzędzi VEXcode GO z wyróżnionym przyciskiem Start.