Usando blocos de comentários#

Using Comment Blocks

Este tutorial aborda como utilizar blocos de comentários no VEXcode GO. No final, saberá porquê e como utilizar os comentários para documentar um projeto.

Os blocos de Comentário permitem adicionar notas diretamente à sua pilha de blocos, que se encontram na categoria Lógica - Comentários na caixa de ferramentas. Não afetam o funcionamento do seu projeto — servem apenas para o ajudar a si e a outras pessoas a compreendê-lo.

O bloco de comentários padrão, apresentado abaixo quando iniciado.#
quando iniciar :: hat events
[comment]

Os programadores utilizam os comentários para organizar o seu código e torná-lo mais fácil de ler e compreender, tanto para eles próprios quando regressam ao projeto mais tarde como para outras pessoas que trabalham nele. O nome de um único bloco descreve apenas esse bloco específico, mas um comentário pode descrever o comportamento de uma secção inteira de blocos de uma só vez — permitindo compreender o que uma pilha de blocos faz rapidamente, sem ter de ler cada bloco individualmente.

Por exemplo, este projeto avança até encontrar um obstáculo, e depois recua. Da forma como está escrito, compreender isto exige a leitura de cada bloco.

Um projeto que avança até encontrar um obstáculo, e depois recua.#
quando iniciar :: hat events
conduzir [frente v]
aguardar até <[bumper v] pressionado? :: custom-led>
parar de conduzir
conduzir [inverso v] por (100) [mm v] ▶

Adicionar um comentário acima de cada secção descreve o seu comportamento, tornando o projeto mais fácil de compreender à primeira vista.

O mesmo projeto, com comentários que descrevem o comportamento de cada secção.#
quando iniciar :: hat events
[Drive forward until something is in the way.]
conduzir [frente v]
aguardar até <[bumper v] pressionado? :: custom-led>
[Back away from the object.]
parar de conduzir
conduzir [inverso v] por (100) [mm v] ▶

Após ligar o seu robô ao VEXcode, selecione Iniciar para executar o projeto. O robô irá avançar, parar e recuar assim que colidir com algo.

Captura de ecrã da barra de ferramentas do VEXcode GO, com o botão Iniciar destacado.