変数の命名方法:読みやすいコードのための開発者ガイド

6 分で読了

変数命名はプログラマーが最も頻繁に行う設計判断です。良い名前はコードを自己文書化し、悪い名前はロジックの解読を強います。

基本原則

  • 意図を明らかにする: dではなくelapsedTimeInDays
  • 誤解を招かない: 実際はセットなのにaccountListと名付けない
  • 発音可能な名前を使う: genymdhmsではなくgenerationTimestamp
  • 検索可能な名前を使う: 7ではなくMAX_STUDENTS_PER_CLASS

型別の命名パターン

パターン
Booleanis/has/can/should + 形容詞isActivehasPermission
カウンター名詞 + Count/TotalretryCounttotalItems
コレクション複数形の名詞usersselectedItems
関数動詞 + 名詞calculateTotalfetchUser
イベントハンドラーhandle/on + イベントhandleClickonSubmit

アンチパターン

  • datainfotempstuff — 曖昧すぎる
  • abx — ラムダや数式でのみ許容
  • flag — 何のフラグ?代わりにisEnabledを使う
  • ハンガリアン記法(strNameintAge) — モダンIDEでは時代遅れ

名前をフォーマット

JavaScriptにはcamelCaseコンバーター、Pythonにはsnake_caseコンバーター、またはケースコンバーターハブをご利用ください。