cafegale(LeafCage備忘録)

LeafCage備忘録(はてなダイアリー)と統一しました。

短い変数名を付けるときは3文字以上(できれば3文字)にすべきだし、頭字語にしない。頭字語からほんの少しずらす。

例えば、CheckManager を収める変数名を付けるなら `cm` でなく、例えば `cmg` にする。
頭字語は文脈からほんの少し離れるだけでぱっと見で意味が解らない。
「`cm`・・何の略だったっけな・・」と一瞬考えてしまう。それが目に見えない心理的なロスになる。

そして、短い変数名を付けるとき3文字が読むときにも書く時にも都合がいい。
3文字は書く時には補完を使わずに打てる許容量だ(4文字は補完を使うかどうかのギリギリの線だ)。
そして読むときには直感をつかさどる原始的な脳が瞬間的に把握できる文字量だ。

私は短い変数を気に入っている。短いということは一時的に作られ使われるという視覚的シンボルになる。
それでもほんの数行程度、本当に一度しか使われないのなら1文字2文字の変数もありだと思うけれど*1、それ以上長く使うとか、何度も使う(他の関数で同じようにして同じ名前の変数を作っているなど)ならやはり3文字がベストだと思う*2
そして3文字に近くても頭字語になるならほんの少し文字を足し引きして、元の単語の目立つ音の文字を取り出して作って、なんとなく元の単語が想像できるように作るべきだと思う。

*1:逆にそういう短い期間でなら冗長な変数名でもいい。

*2:実際、変数の寿命よりも使用されている頻度の方がより重要である。使用されている頻度が高いのなら、変数名は短い方がいい。(頻度が高いと変数名が短くても概念として記録できる。)