はじめに
プログラミングを書く上で変数をどういう名前にするか決める作業は避けることができない。最近だと、「codic」や「ChatGPT」を使えば、代わりに考えてくれるが、改めて初心に戻って、どういう変数名が適切なのかまとめてみる。
適切な変数名とは何か
- 初見で見てもどういう変数か分かる
- 読みにくさがない
- プロジェクト、ソースコード内で命名の仕方が統一されている
以上の3点が適切な変数名と考える。
可読性の高い変数名
どんな変数か分かるように具体的な名前をつける。
その際、複数の単語を組み合わせて、変数の意味が一意になるように命名する。
// 悪い例：userだけだと意味が広すぎる
// userの何の情報を表しているのかが分からない
String user;
// 良い例：一目でuserの名前を表しているのが分かる
String userName;
変数の型を暗示させる名前をつける。変数名だけから型が分かれば、変数の型を確認する手間が省ける。
// 回数や数字を表すcnt(count)やnum(number)を付けることでint型を表す
int retryCnt;
int totalNum;
// Boolean型はisを先頭につけることが多い
// 他にもやhasやcanなどを先頭につけてBoolean型を表す
Boolean isEmpty;
Boolean hasToken;
Boolean canRead;
読みやすい名前
キャメルケースを使用する。言語によって様々だが、例えば、Javaの場合だと、最初の単語は小文字で始まり、それに続く単語の最初の文字は大文字にする。
// 単語の切れ目が分かりやすくて読みやすい
int studentAge;
適切な長さの変数名をつける。意味を分かりやすくしようとしすぎて、名前が長くなることがある。返って、読みにくくなるので、そのバランスは大事である。
// 適切な長さの例
int numberOfStudents;
統一された名前
略語には気をつけないといけない。人によって略仕方が違う可能性があるからである。
// 最大値を表す変数
// 最大、値のそれぞれの略仕方が異なる
int maximumValue;
int maxVal;
プロジェクト内でコードを書く際は、略語については共有しておく必要がある。
まとめ
一般的な変数名の命名の仕方についてまとめた。
まだまだ、細かい命名ルールはたくさんあるので、もう少し変数名の命名規則について勉強する。