変数に分かりやすい名前を付けよう

分かりやすい名前を付けて、記憶の負担を減らしましょう。

変数の名前を考えてつけていますか? いい加減につけると、後で同じ変数を利用するときに思い出すのに苦労します。名前は良く考えて適切な名前(変数の中身を推測できる名前)をつけましょう。

良くない名前の付け方

変数を定義するときには、必ず名前を付けますね。このとき、安易な名前の付け方をすると、後で困ることになるので、注意しましょう。

1文字の短い名前

始めてプログラムを書くときに良くやりがちですが、避けるようにしましょう。入力の手間が多少減りますが、それに比べるとマイナスの方が多いですね。

まず、変数名をみても何のための変数か、全く分かりません。こういう名前は名前がついていないのと一緒です。後から利用しようと思っても、どこでどのように使ったか思い出せない、ということになりやすいです。

また、短い名前だと、名前の数がかなり少ないので、気づかずに既に使った名前と同じ名前をつけてしまうことにもなりかねません。そうすると、当然エラーになってしまいます。なので、短い名前は避けるようにしましょう。

存在する関数や変数と同じ名前、似ている名前

既に存在する関数や変数と同じ名前、似ている名前は避けましょう。同じ名前の変数があるとエラーがおきたり、予定外の動作をしたりします。似ている名前をつけた場合は、直接的な不具合はないのですが、変数を混同するなど、人為的なミスが起きやすくなります。

良い名前の付け方とは?

それでは、良い名前とはどんなものでしょうか。名前は長くなっても全く構いませんので、変数に適切な名前をつけましょう。変数の中身を表す名前にすると、覚えやすく、思い出しやすくて良いでしょう。

変数の中身を表す名前

変数には好きな名前がつけられるので、変数の中身を推測できる名前にしておけば、覚えやすい名前になります。このとき、なるべく長い名前をつけておくほうが、思い出すときの手がかりが多いので、思い出しやすくなります。

例えば、変数の中身が訪問者のメールアドレスの場合、単に $mail という名前では、メールアドレスらしきことはわかりますが、訪問者のものか、サイト運営者のものかは分かりません。この場合、$visitor_mail_address という名前にしておくと、中身が何かもすぐわかり、記憶するのも簡単ですね。

変数名は長いのが良い

変数名は長い方が中身を推測しやすく、思い出しやすくなります。迷ったときは長い名前をつけておきましょう。上の例でも、$visitor_mail と $visitor_mail_address で迷うかもしれません。そういうときは、長い方の名前にしておく方が覚えやすいので良いでしょう。

長い名前にすると入力の手間が増える、と思う方もいるかもしれませんね。毎回キーボードから入力すると、確かに面倒に感じるでしょう。そこで、エディタの機能を利用しましょう。たいていのエディタでは補完機能というものがあり、途中まで入力すると、残りを予測してくれます。この機能を利用すれば、$visitor_mail_address という長い名前も、 $visito ぐらいまで入力すると後は補完されます。詳しくはお使いのエディタのヘルプを参照してください。