コーディング規約 - taizo0401 @ ウィキ

h1. ▼コーディング規約

h2. ・改行コード

p((. 改行コードはLF（Linux）で保存。文字列出力時に改行を出力する場合は、 PHP_EOL を使用する

$str= 'aaa' . PHP_EOL;
print $str;

h2. ・変数名

p((. 変数名は全て小文字で表記。単語節はアンダースコア "_" で区切る

$player
$team_id
$world_id

p((. クラスのインスタンスを取得する場合は、頭文字を大文字にする

$Team = new Team();
$Team = ClassRegistry::init('Team');

h2. ・引数

p((. メソッドで定義される引数の変数名はアンダースコア "_" で始める

public function hoge($_arg1, $_arg2, $_arg3) {
}

h2. ・メソッド名

p((. メソッド名は頭文字を小文字としたキャメルケースとする

public function getHogeFoo() {
}

p((. プライベートメソッドは、メソッド名の最初にアンダースコア２つ "__" をつける

private function __kokoDakenoHanashi() {
}

h2. ・コメント（メソッド）

p((. メソッド宣言上部に以下の形式でコメントを残す。

/**
 * hogehoge 内で fugafuga する文字列を返す　　　　　　　　⬅ メソッドの説明を記載する
 *
 * @access public　　　　　　　　　　　　　　　　　　　　　⬅ メソッドのアクセス権を記載する（public / protected / private ）
 * @param string $str1：ふがふがする前の文字列1　　　　　 ⬅ メソッドの引数の型/変数名/説明を記載する
 * @param string $str2：ふがふがする前の文字列2
 * @return string：ふがふがした文字列, null : 処理異常　　　　⬅メソッドの戻り値。戻り値の型/パターン/説明を記載する
 */
public function hogeFoo($str) {
    return $str;
}

h2. ・トランザクション

p((. APIにおけるトランザクションの開始と終了は、基本的にControllerのメソッドにて行い、その他の処理では行わない。

class Controller extends Controller {
    public function index() {
        try {
            $this->Model->begin();

            …

            $this->Model->commit();
        } catch ( Excaption $e ) {
            $this->Model->rollback();
        }
    }
}

h2. ・エラー処理

p((. API処理中に異常があった場合は、例外(Exception)を発生させる。 例外は基本的にControllerのメソッドにてキャッチする。

class Component extends Component {
    public function getXXX() {
        $ret = $Model->find( 'all', $param );
        if( $ret == null ) {
            throw Exception( $msg, $error_code );
        }
    }
}