前の記事 ≪:高橋メソッド風GIFアニメーションジェネレータ
次の記事 ≫:SERVER_NAMEとHTTP_HOSTの違い

Zend Framework標準コーディング規約

2006年05月11日-はてなブックマーク

スポンサード リンク

Zend Framework

PEARの標準コーディング規約というのがありますが、Zend Frameworkにも定められています。
頭に留めておくため、簡単に列挙してみました。

  1. PHPのみのコードは最後の ?> を含めないようにする
  2. タブ文字は使わず4文字の半角スペースでインデント
  3. 1行を80文字以内に抑えるようにする。長くても120文字
  4. 改行コードはLFで統一
  5. クラス名は英字で定義するのを推奨。ZendパッケージのクラスはZend_を最初につける。
  6. インターフェースは名前の最後に_Interfaceを付与する。
    例)Zend_Controller_Dispatcher_Interface
  7. ファイル名は拡張子をphpにする。incは使わない。
  8. クラス定義したファイルは次のように階層的に設置する
    Zend_DB → Zend/Db.php
  9. メソッド名にアンダースコア( _ ) は含めない。
    悪い例) remote_get
    良い例) RemoteGet
  10. setter/getterのメソッド名は set〜、get〜の形にする
  11. グローバル変数はなるべく使用しない
  12. 変数名にアンダースコア( _ ) は含めない。そして分かりやすい名前をつける
  13. 定数名にはアンダースコアはOK。ただしすべて大文字英数を使う。
  14. 定数宣言の場合はdefineでなくconstを使う。
  15. <? タグは使わず、 <?php タグでコードを開始する
  16. 文字列に変数を含める場合は "あいうえお${hensu}かきくけ" は使わない。
    "あいうえお$hensuかきくけ" あるいは、
    "あいうえお{$hensu}かきくけ" を使う。
  17. 文字連結の場合は "あああ" . "いいい" のようにして . の前後に半角スペースを入れる。
  18. クラスにはPHPDocumentor用のコメントを入れる
  19. one true braceでクラスを定義する。クラス名と後の { の間に改行を加える
  20. ひとつの PHP ファイルにはクラス定義をひとつだけ含めるようにする
  21. メンバ変数はメソッドの定義前にすべて定義し、varは使わない。
  22. メソッドの参照渡しは行わない。function a(&$a) ←メソッドにおいてこれは禁止。関数ではOKらしい
  23. 返り値は () で囲まない return ($a); ←これはだめ
  24. 関数呼び出し時は次のように,の後にスペースを入れる
    test(1, 2, 3);
  25. if 文の () 前後にスペースを入れる。
    例)
    if ($a != 2) {
        $a = 2;
    } elseif ($a == 3) {
         $a = 4;
    } else {
         $a = 7;
    }
  26. if 文の { } は省略しない
    if (1) echo "hogehoge"; ←これはだめ

PEARのコーディング規約に似ていますが、追加でいろいろ規定されているようです。
コードを統一したい方は参考にするとよいですね。

話は変わりますがZendFrameworkのページ、なかなかかっこよくなってますね。
ロゴがよい感じです。

関連の記事検索:PHP, Zend Framework, framework, 規約, zend, コーディングルール
スポンサード リンク

By.KJ : 2006年05月11日 09:06 livedoor Readerで購読 Twitterに投稿

間違いの指摘をしていただける方はメール、あるいはTwitter/FBでお願いします(クリック)