unoh.github.com

変数名について

Mon Dec 13 07:07:52 -0800 2010

皆様、こんにちは。
トクヤマです。

今回はTipsでも何かをお伝えするものでもなく、逆に皆様のご意見を承りたいと思っています。

変数名というのはプログラマーやエンジニアで個性が強くでる部分ではないかと思います。
所属する会社やグループで決められた命名規則に沿って変数名を決めている方も多いと思いますが
内心はもっとこんな命名をしたい!なんて思っている方も多いのではないでしょうか。

例えば私は業務や私用を含めPHPを主に使用していますが私用的な変数名の付け方は格納する値の型+格納する値の意味(英名で)にしていて、
それをキャメルケースで命名しています。

ゲーム開発でユーザーの体力を格納する変数名は
$intUserHitPoint
というようにです。

しかしこれで困るのが格納する値の意味が意味合いが変、もしくは冗長的になってまうときです。
例えばユーザーが敵に攻撃を受けて減った分の体力の総計値を格納する変数を作るときです。

$intEnemyAttackDamageUserHitPoint

ついついこういう冗長的な一見して意味がわからない変数名をつけてしまいます。
ここで一気に簡素化して

$intEnemyAttackDamage

で、良いように思いますがこれでは敵から与えられるダメージ値だけという意味に捉えられかねません。

こういったように変数名の命名で一瞬躊躇してしまう事はあるのではないでしょうか。

もちろん仕様書に明確に変数名とその詳細を記載することは当然としても、
やはりプログラムを見てすぐに他の方にもわかるような命名をしたいものです。

皆様はどういった命名方法をなされているのでしょうか。
何かわかりやすい命名をしているなどありましたらご意見やご教示を頂ければ幸いです。