分かりやすい変数命名

Question

前提

変数命名作法を教えていただきたいです。
現在、社員番号(employee_id)による絞り込みで平均値を算出しています。そこで、「社員番号による絞り込み無し」での平均値算出と「社員番号1～30番のみ」での平均値算出を行いたいです。
それに伴い、それぞれの求めたい平均値の変数名を決める必要があります。
パッと見ただけで、「社員番号による絞り込み無しの平均値」と「社員番号1～30番のみの平均値」であることが分かるような変数名はどのように命名すればよいでしょうか。

実現したいこと

変数を見ただけで、どの範囲の番号で絞られた値なのかがわかるようにしたい。

試したこと

現状は、このように変数を命名しようと考えているのですが、特に「社員番号1～30番のみの平均値」の命名が上手く思いつきません。

・ave_employee_id_all：社員番号による絞り込み無しの平均値
・ave_employee_id_○○：社員番号1～30番のみの平均値

Comments

[melian]

ave_employee_id_le30 など(Less Equal 30)。ただ、30 という数値が将来的に magic number 化しそうではありますが。

[int32_t]

本題ではないのですけども、社員の何の値の平均値なのでしょうか。

[Zuishin]

もし仮に役員には 30 までの社員番号を割り当てるという決まりがあり、求める平均値が平均報酬であるとすれば、役員の平均報酬ということが伝わる関数名の関数を作るべきです。
それを一時的に保存する変数名には average などの簡単なもので十分です。
凝った変数名をつけなければならない場合、関数が肥大化しすぎている疑いがあります。

更に言えば、社員番号は使い回すべきではなく、退任した人の使っていた番号は欠番とし、役員かどうかは社員番号以外のプロパティとして与えましょう。

まあ課題でしょうが。

Answer 1

「社員番号1～30番」が本当に「社員番号1～30番」の意味しかないなら
average_[what]_of_employee_id_1_to_30
なにの平均か、つまり[what]部分がスコープから明らかなら
average_of_employee_id_1_to_30

しかし、「1～30番」というのはおそらく表示の都合やビジネスロジックなど
何かしらのルールによる結果でしょうから、
「社員番号1～30番」が表す本当の意図を探して命名したほうが適切かもしれません。

Comments

[program777]

変数名の途中であれば、数字を用いても良いのでしょうか。
具体的には、「average_of_employee_id_1_to_30」です。
数字は極力使わない方がよいとどこかのどこかのサイトでみたことあるような気がしていて、、、

[ozwk]

変数名の途中に数字を使える、使えないという話の仕方だと、
シンタックスエラーを起こさないので使えます。

「数字は極力使わない方がよい」というのは動作以外の面でどうか?という話で、
* 数字の部分は将来的に変更になる可能性が高い
* 数字だとコードを読んだときに意図が伝わらない、質問文の例だとなぜ1から30までなのかがわからない
という点で、数字を含めるほうがいい場面が少ない
ということです。

ですから、1から30である理由が課題で特に説明などなくそう決まっているとかであれば
変数名に数字を含めていいでしょう。

Answer 2

1から30で固定であれば私はave_employee_id_1_to_30やave_employee_id_top30などと命名します。
固定でなければave_employee_id_particallyなど部分的な平均であることがわかる変数名であれば良いのではないでしょうか……
ただし、特に全世界共通の命名規則があるわけでもないので、ほんの少しでも心配に思ったら宣言時やプログラム行頭のコメントにどういった内容を表す変数なのかを書いておくといいと思います。