ZendFramework >> 2.命名規則

2.命名規則

ファイル名

• 使用可能な文字は「英数字」「アンダースコア(_)」のみ
• 拡張子は必ず「.php」でなければならない
• 誰が見ても意味の分かる名前をつける
• 英単語のみの構成を推奨

ファイル命名

良い例	悪い例	理由
new_user.php	item_sakusei.php	日本語と英単語が混在している
editItem.php	zaiko_koshin.php	ハイフンや日本語を使用している
RegistColumn.php	regist1.php	用途が分かりづらい

• 入力→確認→完了など、一連の流れを複数のプログラムで実現する場合は、同一名称＋語尾装飾にする

「同一名称＋語尾装飾」の例

new_user.php         //入力画面
  ↓
new_user_conf.php    //確認画面
  ↓
new_user_fin.php     //完了画面

変数

• 使用可能な文字は「英数字」のみ
• 「アンダースコア(_)」は使用不可
• 数字の使用は最小限にとどめる
• 通常は「camelCase」形式で決める(54ページ参照)
• 変数名は省略しすぎない（「$i」や「$n」のような省略形は、小さなループ内でのみ使用する）

変数名の例

$userName
$currentPage

• クラス内で「private」あるいは「protected」と宣言されている変数は、変数名の頭にアンダースコア(_)を１文字付けなければなりません。

関数（メソッド）

• 使用可能な文字は「英数字」のみ
• 「アンダースコア（_）」は使用不可
• 数字の使用は最小限にとどめる
• 通常は「camelCase」形式で決める
• 関数名は省略しすぎない
• コードを理解しやすくする為、できるだけ詳細な命名をする

関数名の例

createItem();
updateStock();
checkTemplateData();

• オブジェクト指向型のプログラミングでは、オブジェクトにアクセスするためのメソッドは「get」あるいは「set」のいずれかで始めなければなりません。
• デザインパターンを使用する場合は「singleton」や「factory」などのパターン名を含めるようにしましょう

定数

• 使用可能な文字は「英数字」「アンダースコア(_)」のみ
• 全て大文字とする
• 可読性向上の為、英単語にはアンダースコア(_)を入れる

クラス

• 使用可能な文字は「英数字」のみ
• 「アンダースコア(_)」は使用不可
• 大文字から開始する
• 複数の単語からなる場合は、各単語の１文字めを大文字にする

クラス名の例

DataAccess();
DiplayInfomation();