一般的な変数の命名則
何を言っているのか分からないものは、まずやめる
flag
とか f
とか。
- 抽象化されたユーティリティークラスでラムダ式を渡す場合の引数側の名前が
f
とかは分かるが・・・
文法上の情報を盛り込もうとするのはやめる
- ハンガリアン記法 もどきになってしまうのでやめる。
- 構造体の実体変数の名前が
○○_struct
とか
file_list
ではなく files
読む側からわからないレベルの省略はやめる
- そもそも、単語を省略すると、以下のような問題が発生する場合がある。
- 何を言っているのか分からなくなる。
- 下手な省略が複数あると、伸ばした時に別の単語になる者同士で、略号が衝突する可能性がある。
- 省略の仕方による表記ゆれが発生する。
- 全てかいた場合が長すぎる場合を除きなるべく全て書いた方がよい
- 以下の場合は、省略形の方が好ましい
- スコープが非常に短いうえに、伸ばすと長い場合
- 省略形が一般的に浸透している。もしくは少なくとも、そのプロジェクトに関わる人の間では浸透している。
- 略号が浸透していて、むしろ伸ばしたものの方が一般には認知されていないもの
- USB (Universal Serial Bus), IEEE (The Institute of Electrical and Electronics Engineers, Inc.) など
- ループカウンタの様に短い表記が好ましいものもある。
- コンパイラーやコンパイル環境が非力で、変数名が長いと生産性に影響するような場合は短い名前を使う。
明瞭で具体的かつ、対象を限定するものがいい