2008年10月15日水曜日

スクリプトの話(11)〜最後はコメント!

さて、リンデン・スクリプトは基本的に自分しか見ないものだけれど、
時間が経てば自分も他人になってしまい、
何でこんなものを書いたかすらわからなくなることもある、
だからこそ、見やすくわかりやすいスクリプトを書こう、
そんな趣旨でここ何回か書いてきました。
しかし、字下げや名前の付け方だけではカバーできないところもあります。
そもそも何故そんな変数や関数を作ったのか、
後から見ると忘れてしまってることもあります。
そんなややこしいことをする時は、
コメントを入れておくといいですね。
この変数は何故必要なのか、
この関数はどういうはたらきをするのか
簡単に書いておくといいのです。

コメントというのは文字通り説明ですが、
コンピュータがプログラムの部分とは見なさい文のことです。
リンデン・スクリプトでは、スラッシュを2つ入れると、
その後、行の最後までに書いてあるものは無視されます。

関数の時はその関数のすぐ前に
こんな風に書いておくといいでしょう。

// 現在の自分の位置を取得する関数
getNowPos()

// ドアを開ける処理
openDoor()

こんな感じです。

変数の場合は、変数はズラズラとスクリプトの冒頭に並ぶこともあり、
いちいち上下にコメントが入ったのでは
何がなんだかわからなくなります。
そこで、その変数の後に書くことをお勧めします。

list colorList // ボタンに表示する色のリスト
string colorName // ボタンで選択した色の名前
vector colorValue // 選択した色のベクトル値

といった具合です。

コメント「//」の始まる縦の位置を揃えておくと
もっと見やすくなりますね。

僕はかなり長い「if文」や
「touch_start」と「Listen」と「dataserver」
それぞれの間が長い処理、
一旦外の関数に出てまた戻ってくる処理など
結構長丁場のスクリプトを書くことがあります。
そうすると、その長いスクリプトから
目的の場所を見つけるのに結構時間がかかったりします。
そんな時も、このオレンジ色で表示された日本語のコメントは
ぱっと目に入ってきて助かります。
是非是非自分のために
コメントをつけることをお勧めします。

     *   *   *

ここ数回は、コーディング・スタイルという、
殆どスクリプトの形を整えることを中心に書いてきました。
これらは別にスクリプトの動きに直接影響するわけではありません。
なので、面倒でもあり、手を抜きたい部分でもあります。
が、逆にこの形の部分を最初にしっかりとしておけば
間違いも減り、仮に間違えてもすぐ気づくので
より早くスクリプトを完成させることもできるのです。

そして!
実はここまで長々と書いてきたことは全て
うまく動かないスクリプトの原因を知るための前提なのです。
原因の調べ方については、いよいよ次回から書いていきます。
大変お待たせしましたが、是非楽しみにしていて下さい。

それでは、また。

No response to “スクリプトの話(11)〜最後はコメント!”

Leave a Reply