変数名やメソッド名を分かりやすくする具体例を載せていきます。(随時更新)
データの取得
get/setを使いがちですが、取得元によって単語を使い分けるとコードが理解しやすくなります。
| 命名 | 使うタイミング |
| load / save | 外部データの取得 |
| fetch / store | DBから取得 |
| download / upload | ネット上から取得 |
比較
compareという単語を使うと、どんな処理なのか想像がつきません。
どのように比較するかの情報を含めましょう。
| 命名 | 使うタイミング |
| exists | 存在しているか |
| contains | 要素を含んでいるか |
| equals | 同等か |
| is_smalld | 小さいか |
接頭辞
check等の単語ではなく、接頭辞を使うとどちらの状態かわかりやすくなります。
| 命名 | 使うタイミング |
| is◯◯ | 〇〇であるか |
| has◯◯ | 〇〇を持っている |
| can◯◯ | 〇〇できる状態か |
状態の切り替え
toggle等の単語ではなく、どちらの状態か分かる単語を使用します。
| 命名 | 使うタイミング |
| turnOn / turnOff switchOn / switchOff | 状態のON/OFF |
範囲
最大/最小 や 以上/以下 も命名でわかりやすく表します。
| 命名 | 使うタイミング |
| max / min | 最大・最小 |
| first / last | 範囲指定(以上・以下) |
| begin / end | 範囲指定(以上・未満) |
単位や属性をつける
変数名に単位や属性をつけると、ひと目で格納された値の意味が分かります。
| 命名 | 使うタイミング |
| delay_secs | 時間(秒) |
| size_mb | データサイズ(MB) |
| max_kbps | 通信速度(kbps) |
| degrees_cw / degrees_cw | 角度(時計回り) / 角度(反時計回り) |
| plaintext_password | パスワード(プレインテキスト) |
| unescaped_comment | エスケープ |
| html_utf8 | 文字コード |
| data_urlenc | エンコード |
参考文献
コメント