2008年10月15日水曜日

スクリプトの話(10)〜変数、関数の名前

見やすいスクリプトを書く方法として、
前3回にわたって字下げや改行について書いてきました。
この他にわかりやすくする方法に
変数や関数の名前の付け方というのがあります。

変数や関数は自分で自由に作れるところですので、
自分さえわかっていればいいのですが、
前に書きましたように、しばらく経つと
その自分が他人になってしまうことがあるのも事実です。
そこで、やはり決め事をしておいた方がいいのですが、
ここまで来るともう、いろんな人がいろんな事を言ってますので、
実はこの項は書こうかどうしようかと
今まだ迷っている位なのです。
が、こうしたことも初心者の方にとって
何かの参考になるかもしれず、と思い、
やはり書かせて戴くことにします。
さらっと読んで頂いて、
自分に合った名前の付け方をされることを願っています。

まずは関数から行きましょう。
自分で作った関数の名前は
その関数のはたらき、処理内容がすぐわかるように
「動詞」+「目的語」という形で、単語をくっつけて
最初の単語は小文字、続く単語は始まりの文字を大文字、
というようにつけるといいと思います。
例えば、「今いる位置を取得する」という関数の場合、

getNowPosition

または Position を更に略して

getNowPos

といった具合です。
それから、ドアを開ける関数なら

openDoor

ノートカードからその内容(文字列)を読み込む関数なら

getStringFromNote
或いは、
loadStringFromNote

といった具合です。

因みに、この、最初だけ小文字で初めて
途中の頭文字を大文字にする書き方はキャメル型と呼ばれています。
キャメル(camel)とは英語で「ラクダ」のこと。
頭が小さくて背中がボコボコしてるのがラクダみたいだからとか。w

変数も同じような感じで名前をつければいいと思います。
もっとも、今度は動詞は不要ですね。
できれば、どういう型のものかもわかるようなものがいいですね。
例えば、前に出した例で、色に絡む変数を考える時、
これをキャメル型で書くとしたら、

色名を入れておくリスト型 colorList
色そのものの名前=文字列型 colorName
色を指定するベクトル型 colorValue
色の順番を表す整数型 colorNumber

といった感じですかね。
前に話しました、型を表す頭文字を使うとすると、それぞれ、

lstColorList
strColorName
vecColorValue
intColorNumber

といったところでしょうか。
因みに、この書き方にも呼び方があって、
こちらは「ハンガリアン」と呼ばれています。
何故ハンガリーなのか、興味ある方は調べてみて下さい。w

まぁ、最初に書きましたように、
ここは自由な部分ですのでこの程度で止めておきます。
何れにしても、自分すら他人になる可能性もあるので、
誰が見てもわかりやすい名前にしておく
というのが大事です。

それでは、今日はこの辺で。

No response to “スクリプトの話(10)〜変数、関数の名前”

Leave a Reply