変数の命名方法

こんにちは。

今日は、変数の命名方法について書いてみます。

プログラマの中には、命名規則に沿っていないソースコードを書く人がいます。

特に、経験の浅い人は、自分の好きなように、関数名や変数名を書く人が多いようです。

しかし、システム開発は、1度作ったら終わりとなる開発はありません。

有名なシステムの場合は、半年ごとに機能が見直されるため、自分が作った機能を、他の誰かが改造することは良くあります。

なので、命名規則には十分に注意が必要なのです。

では、最低限守った方がいい命名規則が以下になります。

• 英単語を使用する
• 1文字の変数は使用しない
• プロジェクトで統一する

では、それぞれ説明しますね。

英単語を使用する

変数は、見ただけで何の値が格納されているのかが分かるように命名します。

プログラマの中には、日本語をローマ字で書く人もいます。

確かに、日本語をローマ字にした変数名だと、日本人には分かりやすいかもしれません。

しかし、今はグローバル社会ですよね。

今外国人と仕事していなくとも、後々、そのソースコードを外国人が修正するかもしれない。

その時、日本語をローマ字に変換しただけの変数名だと、外国の方には、記号にしか見えないのです。

なので、ソースコードを誰でも修正できるように、変数名は、英単語の変数名にしましょう。

1文字の変数は使用しない

日本語をローマ字に変換しただけの変数が、外国人には記号にしか見えないのと同じように、1文字の変数は誰が見ても記号です。

特に、入れるのインデックス値を1文字の変数にする人が多いです。

1文字の変数は、見てすぐに何の変数か分かりませんよね。

インデックスならば、indexと書いてあった方が意味が分かりやすいですよね。

これて、修正に修正が入って、ソースコードが長くなったりすると、1文字変数は意味が分からないくなることが良くあります。

なので、ソースコードが長くなると、不具合の原因になることが良くあるのです。

私も、長く修正が行われているソースコードで、1文字変数の意味が途中で変わって不具合になっているのを見たことがあります。

なので、1文字の変数は使わないようにしましょう。

1文字の変数が良く使われるのは、ちょっとしたサンプルのソースコードで良く使われるからです。

サンプルのソースコードって、短いし、後に修正が行われることを考える必要がないので、1文字の変数でもいいのです。

しかし、仕事でソースコードを書く場合は、後に修正が行われることを意識して書く必要があるのです。

プロジェクトで統一する

変数名の付け方は、プロジェクトで統一しましょう。

開発する時は、統一されているかもしれませんが、修正されるたびに変数名がぐちゃぐちゃになることが良くあるのです。

一番ひどいのが、英単語の変数名と日本語をローマ字に変換した変数名が混在している場合です。

プログラマの中には、自己流の命名規則に則って修正を行う人が結構いるのです。

修正する時に、命名規則がない場合は、修正する前にソースコードを読みましょう。

必要なソースコードだけでなく、他のソースコードも読むと変数名をどうすれば良いかは分かるはずです。

今は、オブジェクト思考でコーディングされていることが多いですよね。

なので、必要なクラスのソースコードや、継承元のソースコードを読めば良いのです。

まとめ

では、もう一度繰り返しますね。

変数名をつける時は、以下のことに気おつけるようにしましょう。

• 英単語を使用する
• 1文字の変数は使用しない
• プロジェクトで統一する

少なくとも上記のことに気おつけることで、ソースコードが読みやすくなります。

できれば、会社で命名規則を統一しておくと、他のプロジェクトでも取り組みやすくなるので良いと思います。

では、今日はこの辺で。