第6章 コメント

登録タグ： HSP3 Hot Soup Processor Hot Soup Processor3 ホットスーププロセッサー コメント コメントの必要性

今回は、コメントについて説明します。
コメントといっても、TVのインタビューなどのコメントではありません。

プログラミングのコメントとは、スクリプト内に記述しても、実際には表示されない文章のことです。
そのため、その場所で何を処理しているかなどをメモするために使用したりします。

下のスクリプトで、コメントは黄緑色になっています。

; タイトルを表示
title "はじめてのHSP"
; メッセージを表示
mes "Hello, HSP World!"
stop

コメントの書き方はいろいろあります。
行頭に半角の；（セミコロン）を書いたり、行頭に半角の/（スラッシュ）を２度続けて書いたりすると、その行はコメントになります。
また、半角の/*から半角の*/までの間の文章もコメントになります。

; これはコメントです
// これもコメントです
mes "コメントの範囲外です。"
/* ここは、コメントの範囲内なので
下に記述した命令もコメントになってしまいます。
mes "コメントの範囲内です。"
そのため、命令などを一時的に隠すこともできます。 */
mes "コメントの範囲外です。"
/* コメント */ mes "コメントの範囲外です。" /* です */
stop

たくさん書きましたが、こんな感じです。

いろいろな書き方ができるので、自分の好きな書き方でコメントを記述していってください。

ちなみに余談ですが、なぜコメントが必要なのかというと、それはつまり人間が物忘れする生き物だからです。
複数人でチームを組んで制作するときなどのコメントの必要性は、処理内容の伝達や確認、メモなどの観点から必要になってきますが、1人で行うときはさほど必要には感じられないように思えます。

しかし、ある人が書いたプログラムは数ヶ月経つと他人が書いたプログラムになると言われるように、たとえ1人で作成したプログラムであっても月日が経過するとだんだんと(作成した本人が)その内容を忘れてしまいます。

それが小規模ならまだしも、中規模・大規模となってくると少しのミスが最悪プログラム全体の大きな不具合を起こすこともあります。
そのため、小さなミスや勘違い等を防ぐ意味でもコメントは大事になってきます。

← 前へ | 次へ →

カテゴリー:HSPの基本編
2011/09/12 23:15:09 更新