CakePHPのコーディング規約
CakePHPのコーディング規約が書かれているページはこちら。
内容を簡単にまとめると以下の通りです。
- インデント(缩进)
- インデントには１つのタブを使用します。
- 関数の呼び出し(函数调用)
- 関数名と開始ブラケット(括弧)の間に空白なし。パラメータ(引数)の間には空白を1つ。
- イコール(赋值)
- イコールサイン(=)の両脇には1つの空白を設ける。可読性を高める場合に空白の前に追加する場合もある。
- メソッドの定義(方法定义)
- デフォルト値を持つパラメータは関数定義の最後に置く。関数はtrue/falseを返す。
- コメントコード(注释)
- コメントは英語で書く。コメントはphpDocumentorのタグを記述する
- @access
- @author
- @copyright
- @deprecated
- @example
- @ignore
- @internal
- @link
- @see
- @since
- @tutorial
- @version
- inline {@internal}}
- inline {@inheritdoc}}
- inline {@link}}
- ファイルのinclude(文件的include)
- require_once 関数だけを常に使用する
- PHPタグ(PHP标记)
- ショートタグ(<? ?>)は使わないで長いタグ(<?php ?>)を使う
- 関数の命名規則(函数命名规则)
- ローワーキャメルケース(複合語の先頭を小文字。例：longFunctionName)で記述する
- クラスの命名規則(类命名规则)
- キャメルケース(複合語の先頭を大文字。例：ExampleClass)で記述する
- 変数の命名規則(变量的命名规则)
- できるだけ短く明記し、通常は小文字で始め、複合語の場合はキャメルケース出記述する
- protectedメソッド
- 単一のアンダースコア (“_”) で始める
- privateメソッド
- ２つのアンダースコア (“_”) で始める
- アドレスの例
- URLやメールアドレスの例にはすべて、example.com, example.org, example.netを使用する
- ファイル名
- ファイル名は小文字で生成し、ファイル名が複数の単語からなる場合は、アンダースコアで区切る
- 定数
- 定数は大文字で定義する。複数単語の場合はアンダースコア(_)で区切る