Zend Framework標準コーディング規約
2006年05月11日-
スポンサード リンク
Zend Framework
PEARの標準コーディング規約というのがありますが、Zend Frameworkにも定められています。
頭に留めておくため、簡単に列挙してみました。
- PHPのみのコードは最後の ?> を含めないようにする
- タブ文字は使わず4文字の半角スペースでインデント
- 1行を80文字以内に抑えるようにする。長くても120文字
- 改行コードはLFで統一
- クラス名は英字で定義するのを推奨。ZendパッケージのクラスはZend_を最初につける。
- インターフェースは名前の最後に_Interfaceを付与する。
例)Zend_Controller_Dispatcher_Interface - ファイル名は拡張子をphpにする。incは使わない。
- クラス定義したファイルは次のように階層的に設置する
Zend_DB → Zend/Db.php - メソッド名にアンダースコア( _ ) は含めない。
悪い例) remote_get
良い例) RemoteGet - setter/getterのメソッド名は set〜、get〜の形にする
- グローバル変数はなるべく使用しない
- 変数名にアンダースコア( _ ) は含めない。そして分かりやすい名前をつける
- 定数名にはアンダースコアはOK。ただしすべて大文字英数を使う。
- 定数宣言の場合はdefineでなくconstを使う。
- <? タグは使わず、 <?php タグでコードを開始する
- 文字列に変数を含める場合は "あいうえお${hensu}かきくけ" は使わない。
"あいうえお$hensuかきくけ" あるいは、
"あいうえお{$hensu}かきくけ" を使う。 - 文字連結の場合は "あああ" . "いいい" のようにして . の前後に半角スペースを入れる。
- クラスにはPHPDocumentor用のコメントを入れる
- one true braceでクラスを定義する。クラス名と後の { の間に改行を加える
- ひとつの PHP ファイルにはクラス定義をひとつだけ含めるようにする
- メンバ変数はメソッドの定義前にすべて定義し、varは使わない。
- メソッドの参照渡しは行わない。function a(&$a) ←メソッドにおいてこれは禁止。関数ではOKらしい
- 返り値は () で囲まない return ($a); ←これはだめ
- 関数呼び出し時は次のように,の後にスペースを入れる
test(1, 2, 3); - if 文の () 前後にスペースを入れる。
例)
if ($a != 2) {
$a = 2;
} elseif ($a == 3) {
$a = 4;
} else {
$a = 7;
} - if 文の { } は省略しない
if (1) echo "hogehoge"; ←これはだめ
PEARのコーディング規約に似ていますが、追加でいろいろ規定されているようです。
コードを統一したい方は参考にするとよいですね。
話は変わりますがZendFrameworkのページ、なかなかかっこよくなってますね。
ロゴがよい感じです。
スポンサード リンク
Advertisements
SITE PROFILE
最新のブログ記事(新着順)
- 小説表紙などに使えそうな商用可なフォント「になロマン」
- 筆で書いたようなカナ書体「筆竹仮名B」
- 無料・商用利用可な丸文字ピクセルフォント「マルミーニャM」
- スペースコブラ風フォント
- Next.jsのVercelから商用利用可能なフリー汎用フォント「Geist Font 」
- 無料で使えるいい感じの日本語フォント「しっぽり太ゴシック」
- CSSのみで実装された500種類のローディングアニメーション「CSS Loaders」
- 画像ホバーで様々なエフェクトをかけられる「Izmir」
- CSSのbox-shadowをGUIで生成できる「CSS Box Shadows Generator」
- 好きな画像や文字を埋め込んだQRコードをリアルタイムで作れるWEBツール
- 過去のエントリ