Использование блоков комментариев#

Using Comment Blocks

В этом руководстве рассматривается использование блоков комментариев в VEXcode GO. К концу вы узнаете, зачем и как использовать комментарии для документирования проекта.

Блоки Комментарии позволяют добавлять заметки непосредственно в ваш набор блоков, которые находятся в категории Логика - Комментарии на панели инструментов. Они не влияют на работу вашего проекта — они нужны только для того, чтобы помочь вам и другим пользователям понять его.

Блок комментариев по умолчанию, расположенный ниже при запуске.#
при запуске :: hat events
[comment]

Программисты используют комментарии для организации своего кода и упрощения его чтения и понимания, как для себя, возвращаясь к проекту позже, так и для других, работающих над ним. Название отдельного блока описывает только этот один блок, но комментарий может описывать поведение целого раздела блоков одновременно — таким образом, вы можете с первого взгляда понять, что делает набор блоков, не читая каждый блок по отдельности.

Например, этот проект движется вперед, пока не наткнется на что-нибудь, а затем отступает. В том виде, в котором он написан, для понимания этого необходимо прочитать каждый блок.

Проект, который движется вперед, пока не наткнется на что-нибудь, а затем отступает.#
при запуске :: hat events
движение [вперёд v]
ждать пока <[bumper v] нажат? :: custom-led>
остановить движение
движение [назад v] на (100) [мм v] ▶

Добавление комментария над каждым разделом, описывающего его поведение, делает проект более понятным с первого взгляда.

Тот же проект, с комментариями, описывающими поведение каждого раздела.#
при запуске :: hat events
[Drive forward until something is in the way.]
движение [вперёд v]
ждать пока <[bumper v] нажат? :: custom-led>
[Back away from the object.]
остановить движение
движение [назад v] на (100) [мм v] ▶

После подключения вашего робота к VEXcode, выберите Start, чтобы запустить проект. Робот будет двигаться вперед, останавливаться и отъезжать назад, как только столкнется с чем-либо.

Скриншот панели инструментов VEXcode GO с выделенной кнопкой «Старт».