開発ページ > コーディング規約 > 命名規約
命名規約
ファイル名
ファイル名は、英数字、アンダーバー「 _ 」、ハイフン「 - 」のみとする。
ファイル名には、中身がわかるファイル名を付ける事を心がけること。
PHPコードを含むファイルの拡張子は「.php」を原則とする。
Zend Frameworkの言う、ビュースクリプトは例外として扱う。
ヒアドキュメントのみのファイルの場合も例外として認める。(下記例)
aaa.php
<?php
$title = 'title';
require('.aaa.tpl');
?>
aaa.tpl
<?php
echo <<< AAA
<h1>{$title}</h1>
<p>
xxxxx
</p>
AAA;
定数
定数名は英数字、アンダーバーのみとする。
すべて大文字とし、単語の区切りをアンダーバーで区切る。
定数名の単語を省略しすぎないように注意すること。(YMDなどは認める)
TEXT_DATA_MAX
変数
変数名は、英数字のみとする。
アンダーバーの使用は禁止とする。
小文字で開始し、２番目以降の単語の頭文字を大文字とする。(Camel)
変数名の単語を省略しすぎないように注意すること。(Ymdなどは認める)
$fileName $getObject
クラス内で、private、protected宣言されている変数に限り、頭に１文字アンダーバーを付けることとする。
$_fileName $_getObject
関数・メソッド
関数名・メソッド名は、英数字のみとする。
アンダーバーの使用は禁止とする。
小文字で開始し、２番目以降の単語の頭文字を大文字とする。(Camel)
関数名・メソッド名から役割がわかるように名称に注意すること。
userInputCheck() getText()
private、protected宣言されているメソッドに限り、頭に１文字アンダーバーを付けることとする。
_userInputCheck() _getText()
クラス
命名規則は関数・メソッドと同様とするが、頭文字を大文字とする。(Pascal)
class SampleClass
{
//class
}
抽象クラス
命名規則はクラスと同じとする。最後にAbstractを付けることとする。
class SampleClassAbstract
{
//class
}
インターフェース
命名規則はクラスと同じとする。最後にInterfaceを付けることとする。
class SampleClassIntaface
{
//class
}