関数・変数などの命名規約
2011/05/24
適当な関数や変数名は後々に問題が発生するのでルールをまとめてみた。
ZendやPEARに準拠するのが無難らしい。
色々なサイトを見てまとめたものが下記になる。
※ZendやPEARに準拠といいつつ微妙に準拠していないかもしれない。
基本ルール
- 変数名に含めることができるのは英数字のみ
※数字はお勧めしない - 常に小文字で開始する
- 名前が複数の単語で構成されている場合は、各単語の最初の文字を大文字にする
- 変数名は省略しすぎないようにする
- 変数に代入されるものが配列：複数形、それ以外は単数形。
グローバル変数（パッケージでグローバル変数を定義する場合）
アンダースコアで始めパッケージ名、アンダースコアと続ける。
サンプル
$_PEAR_destructor_object_list
グローバル関数
パッケージ名を先頭につけ、次の文字は小文字とし、その後は単語の先頭の文字のみを大文字
サンプル
XML_RPC_serializeData()
※パッケージ名：XML_RPC
クラス
単語の最初の文字は大文字。大文字を連続して使用しない
サンプル
NetFinger
プライベートなクラスメンバ
アンダースコアを1つ前に付けます
サンプル
$_status
定数
すべて大文字、単語の区切りにはアンダースコア
サンプル
DB_DATASOURCENAME