メインコンテンツまでスキップ

基本の命名ルール

HANDBOOKでは、下記のルールに基づいてID名称変数を命名しています。

※このページでは、「商品管理マスタ」(item_master_maintenance)というアプリケーションを作成する場合を想定して例を説明します。

ID

  • IDはスネークケース(snake_case)で命名する
  • アプリケーションを識別できるように、アプリケーションIDを定義する
    • 例:item_master_maintenance
  • アプリケーション内で定義する画面やロジックなどのIDの先頭には、アプリケーションIDを付ける
    • 例:item_master_maintenance_register

名称

※IDと一緒に定義する名前のこと。

  • 名称は半角スペースで区切って命名する
  • アプリケーションを識別できるように、アプリケーション名を定義する
    • 例:商品管理
  • アプリケーション内で定義する画面やロジックなどの名称の先頭には、アプリケーション名を付ける
    • 例:商品管理 登録処理

変数

  • 変数名はキャメルケース(区切り文字のみ大文字)で命名する
    • 例:tableData
  • 真偽値はtruefalseの状態がわかる命名とする
    • 例:isChanged, isUserLocked, ...
  • 意味や役割の固まり(オブジェクト)ごとに変数をまとめる
    • 例:state, control, endPoint, ...
  • 略称の使用を避ける
    • 略称についての統一的な認識がされていない場合、可読性の低下につながります。
備考

IM-BloomMakerの場合、変数のほかに定数や多言語の定義を追加・設定できます。たとえば以下のように命名します。

  • 定数・多言語はコンスタントケース(すべて大文字)とする
    • 例:MAX_LENGTH