コメントブロックの使用

Using Comment Blocks

このチュートリアルでは、VEXcode GO でコメントブロックを使用する方法について説明します。このチュートリアルを終える頃には、プロジェクトのドキュメント作成にコメントを使用する理由と方法が理解できるでしょう。

コメントブロックを使用すると、ツールボックスのロジック - コメントカテゴリにあるブロックスタックに直接メモを追加できます。これらはプロジェクトの実行には影響しません。あくまでも、あなた自身や他のユーザーがプロジェクトを理解するのに役立つものです。

起動時にデフォルトで表示されるコメントブロックは以下のとおりです。

開始したとき :: hat events
[comment]

プログラマーは、コードを整理し、後でプロジェクトに戻る自分自身や、プロジェクトに携わる他の人が読みやすく理解しやすくするためにコメントを使用します。単一のブロック名はそのブロックのみを説明しますが、コメントはブロックのセクション全体の動作を一度に説明できるため、個々のブロックを一つずつ読み通さなくても、ブロックのスタックが何をするのかを一目で理解できます。

例えば、このプロジェクトは何かにぶつかるまで前進し、ぶつかったら後退する。この記述を理解するには、すべてのブロックを一つずつ読み通す必要がある。

何かにぶつかるまで突き進み、ぶつかったら後退するようなプロジェクト。

開始したとき :: hat events
[前進 v] へ走行
<[bumper v] 押された？ :: custom-led> まで待つ
走行停止
[後退 v] へ (100) [mm v] 走行 ▶

各セクションの上にコメントを追加してその動作を説明することで、プロジェクトを一目で理解しやすくなります。

同じプロジェクトに、各セクションの動作を説明するコメントを追加したもの。

開始したとき :: hat events
[Drive forward until something is in the way.]
[前進 v] へ走行
<[bumper v] 押された？ :: custom-led> まで待つ
[Back away from the object.]
走行停止
[後退 v] へ (100) [mm v] 走行 ▶

ロボットをVEXcodeに接続後、開始を選択してプロジェクトを実行します。ロボットは前進し、何かにぶつかると停止して後退します。