ＰＨＰでプログラムを作っていくと
｢変数名はどうしよう？｣
などと、たいしたことではないのに凄く悩むときがあります。

PearとZend Frameworkには標準コーティング規約というものがあります。プログラムを書く上でのルール決めです。いずれも内容的には一致しているところも多く大変勉強になります。
ただ、かなり細かく書いてあるので全てを網羅するには結構大変です。下記にそれぞれのコーティング規約を1つにまとめてみました。

  1. ファイル
    1. 一行の長さは80文字以内とする。最高でも120文字いないとする
    2. 改行はラインフィード( LF )を使用する
    3. ファイル名は英数字、アンダーバー( _ )、ダッシュ( – )以外は使用しない
  2. インデント
    1. インデントはタブを使用しないで半角空白4文字とする
  3. 制御構造
    1. if, for, while, switch等で制御キーワード(if等)と括弧の間は1文字開ける
    2. if等の一行コードでも波括弧( { )をつける
    3. 開始の波括弧( { )は条件文と同じ行に明記する
    4. 終了の波括弧( } )は常に改行し、単独で表記する( else等は除く)
    5. elseifは使用しないelse ifを使用する
    6. switchでbreakやreturnを使用しない場合は” // break intentionally omitted “のコメントをつける
  4. コメント
    1. コメントにシャープ( # )を使用しない
  5. コード
    1. グローバル関数はできるだけ使用しない
    2. 関数呼び出し時は下記の場所に空白をあけない
      • 関数と括弧の間
      • 括弧と最初に引数の間
      • 最後の引数と閉じ括弧の間
      • 閉じ括弧とセミコロンの間
    3. 関数の引数でカンマと引数の間は空白を空ける
    4. 関数代入前のイコール( = )の前後に空白を入れる
    5. 関連する関数代入時はイコール( = )の前に空白を入れてイコールの位置を合わせる
    6. 関数宣言の中身はインデント(one true brace)を行う
    7. 関数宣言の引数でデフォルト値がある場合は最後に配置する
    8. (クラス)ファイルを無条件で読み込む時はrequire_once()を使用する
    9. (クラス)ファイルを条件付で読み込む時はinclude_once()を使用する
    10. 文字列はシングルクォーテーション( ‘ )を基本とし、アポストロフィ()がある場合はダブルクォーテーション( ” ) で囲み、 アポストロフィをシングルクォーテーションで囲む($sql = “SELECT `id`, `name` from `people` WHERE `name`=’Fred’ OR `name`=’Susan'”;　等)
    11. 変数の展開は以下の2通りとする
      • $greeting = “こんにちは $name さん。ようこそ!”;
      • $greeting = “こんにちは {$name} さん。ようこそ!”;
    12. 文字列の連結で使用する”.”の前後は空白を入れる
    13. 文字列の連結を複数行で使用する場合は”.”を”=”と同じ位置にする
    14. 配列のカンマ( , )の後ろは空白を入れる
    15. 連想配列を複数行にするときは”=>”の位置を合わせ”=>”の前に空白を入れる
    16. クラス、関数開始の波括弧はクラス名の下に書く
    17. クラスのメンバー変数でvarは使用しない。private、protected、publicを使用する
    18. 関数の戻り値は括弧でくくらない
  6. タグ
    1. <? ?>のPHPタグは使用しないで<?php ?>を使用する
    2. <?php ?>のPHPタグの後ろは空白を1つ入れる。
  7. 命名規則
    1. クラス、関数名はできるだけ略語を使用しない
    2. クラス名は常に大文字で開始する
    3. クラス内だけで使用する関数は先頭にアンダーバー( _ )をつける( _sort() 等)
    4. クラスファイルのパス区切りにアンダーバー( _ )を使用する(Zend/Db/Table.php → Zend_Db_Table)
    5. クラス名が複数の場合は大文字、小文字を使用してアンダーバー( _ )で区切る( NG：Zend_PDF　OK：Zend_Pdf )
    6. 変数、関数、メソッドの命名は小文字、大文字と小文字で構成し、先頭にはパッケージ名を明記する( getData等)
    7. 関数名にはアンダーバー( _ )を使用しない
    8. protectedメンバーのときはアンダーバー( _ )はつけない(Pearの命名規則とZend Frameworkの命名規則とでは異なります)
    9. 定数は全て大文字とし、区切りはアンダーバー( _ )を使用する
    10. グローバル変数は先頭にアンダーバー( _ )をつける
    11. 変数名は英数字のみとし、アンダーバー( _ )は使用しない
    12. 20行以上のループの場合は変数名を”$i”や”$k”のように省略形を使用しない

もし、おかしな所があればご指摘ください。

【参考】

投稿タグ
, ,