「なるほど！」と納得した変数名の付け方のルール
Advertisements
CODE COMPLETEを読んで、今まで何気なくつけていた変数名にもきちんと意味があることがわかりました。
印象的だったものを紹介したいと思います。
■変数に名前を付けるときに最も重要なことは、変数が表すものを完全かつ性格に説明するような名前を付けること
・このような変数は「名前を読めばわかる」ので、コメントが不要になる
・ただし、変数名が長くなりすぎてしまう可能性もある。
・変数名の適切な長さは、だいたい8～20文字である。
■修飾子を使って名前を修飾する場合は、修飾子を名前の最後に付ける
・totalRevenueではなく、revenueTotal
・averageRevenueではなく、revenueAvarage
・なぜかというと、変数の意味のほとんどを伝える部分が先頭にあるから。
■ループで用いるi,j,kについて
・i,j,kは単純なループのインデックス以外では使用しない
・ループがネストされて長くなる時は、i.j.kの使用について考え直す
■一時変数に注意
・一時変数はtempやxなどが使われる
・一時変数はプログラマが他の変数に比べて軽く扱うため、エラーの可能性が高まる
・そもそもプログラムの変数のほとんどは一時的なものである。それらのいくつかを一時変数と呼ぶことは、それらの本当の目的を理解していないことの表れである
■ブール変数の命名
・done,error,found,success,ok
・is～を付けるのが好きなプログラマもいる。この方法の利点はあいまいな名前では意味不明になることである。
・isDone,isError,isFound,isProcessingCompleteなどはわかるが、isStatusは意味不明になる。
■命名規則の大切さ
・プロジェクトで最初に苦労してでも命名規則を作ることに意味がある
・命名規則を決めておけば、コードの重要な部分に専念できる。
・コードの一貫性が保てる
・後から読むプログラマが保守しやすい
■省略形のガイドライン
・変数名を短くしたいというのは、初期のコンピューティングの名残である。
・C++,Java,Visual Basicなどの現代の言語では名前の長さにはほとんど制限がない。意味のある名前をわざわざ短くする必要はない。
・変数名を省略するなら、ルールを統一すること。
以上。
気になるヒトはCODE COMPLETE(上)を読んでみてください！
