命名規則もろもろ（ファイル名、変数名、関数名、クラス名）。

php, null

phpプログラムを作成する際、コーディングや命名に関して自分流のルール・スタイルを明確にしておくことでより早く・効率よくプログラムを構築することができるはず。

まず、コーディングに関しておおまかには

PEAR :: Manual :: 命名規約

Zend Framework: Documentation

この２つに準拠したコーディングスタイルを身につけると自分に対しても他人に対してもやさしいコードが書けそう。

しかし、この２つを読んでも、まだある程度個人で自由にやってください、というような部分があるように見えますね、とくに各種命名規則については絶対的な正解がないようです。

こちらにも書いてあるように↓

変数名はどう付けよう？ - ホリデープログラミング入門 - Yahoo!ブログ

ひとつのプログラムにはひとつの命名規則があったほうが、後から読みやすいし、コーディングもスムーズに進むでしょう。

命名規則を決めたいもの

• 変数名
• 関数名
• クラス名
• ファイル名
• DBテーブル名

自分流の命名規則

とりあえず自分流の命名規則を決めてみる。

変数名、関数名

変数名はどう付けよう？ - ホリデープログラミング入門 - Yahoo!ブログより引用

・変数名に含めることができるのは英数字のみ

・数字はお勧めしない

・常に小文字で開始する

・名前が複数の単語で構成されている場合は、各単語の最初の文字を大文字にする

・変数名は省略しすぎないようにする

4番目の規約は「camelCaps」と呼ばれるそうです。

$cacheIdとか$objCacheといった具合。

（2008/07/02追記）

・変数に代入されるものが配列のものは複数形・それ以外は単数形の単語にする。

例）$errors（配列）　$error（文字列・オブジェクトなど）

クラス名

クラス名は、常に大文字ではじめて、あとは小文字。

PEAR :: Manual :: 命名規約より

ファイル名

プログラマーが困った時に読むメモ | ファイルの命名規則を考えてみる。

が参考になる、けどここは自分流に。

• classファイル、関数ファイルなどは種類ごとにフォルダに分け。
• ファイル名はすべて小文字。
• 複数単語になる場合はハイフンで区切る。

命名規則を決めとけばプログラム設計もおのずと見えてくる？

基本的に名前を構成する単語が多くなってきたら、それはプログラム設計（class設計）自体を見直すべきかもしれない（ここわりと重要）。

参考

名は体を表す

Permalink | コメント(0) | トラックバック(0) | 12:58