変数・メソッドの命名法

順次加筆予定

原則1:抽象的な命名は避ける

例1(Memoryとは?)

  • writeMemoryのMemoryが何を指すのかが不明瞭。USBメモリキャッシュメモリ?メインメモリ?
  • メモリという名前のつく単語はコンピュータ関連では複数あるため不明瞭になってしまう。
  • 個別の実装内容即した命名などが好ましい。

(前)writeMemory → (後)writeVirtualSegment

例2(getXXX系)

  • setter/getter以外でgetは使わない。紛らわしくて混乱する。
  • getという単語自体が抽象的すぎる。取得方法はDB経由なのかコンフィグファイル経由なのかインターネット経由でダウンロードするのかが不明。
  • 受け取った文字列をRegisterに変更するなら、以下のように別単語に置き換えたほうが好ましい。

(前)getRegister → (後)convert2Register

原則2:情報量の増えない命名は避ける

例1(XXXFunction系)

  • メソッド名がXXXFunctionの場合、Functionはあってもなくても情報量としては同じ。
  • こうした無意味な名前は冗長にするだけなのでつけない。

参考

クラスの命名のアンチパターン - Qiita