日本語化PHPコーディング規約

目的

単に計算式を日本語翻訳するコメントの数を軽減することで、プログラムの説明としてより人間の行為に近づけたコメントを記載する工数のゆとりをつくる。

前提

統合開発環境にeclipse4.3を使い、コードアシスト機能に支障をきたさないこと。

日本語で記載するプログラムコードの要素

これまで英単語ないしはその略語を記載している箇所についてすべて日本語表記を試みる。具体的に以下の要素が対象となる。

• 変数名
• 関数名
• クラス名（※）
• 定数名

（※）URLと同期するアクションコントローラアクション名は日本語化しない。

日本語定数の管理方法

日本語定数は、URLリクエストキーのために実装する。

すべての日本語定数名はclass jpで一元管理する。
（このクラス名を日本語表記にすると、コード中の日本語論理名のプレフィックス文字列としては極めて邪魔になるのであえて短いアルファベットを使用することにした）

テンプレート

//日本語定数辞書クラス
class jp{
    const 彼 = 'he';
    const 名前 = 'name';
    const 年齢 = 'age';
    const 性別 = 'sex';
}
//クラス定義テンプレート
class 人{
    protected $名前;
    protected $年齢:
    protected $性別;
    public function __constructor($名前){
        $this-＞名前 = $名前;
    }
    public function 名前は(){
        return $this-＞名前;
    }
}
//関数テンプレート
function 彼の名前(){
    // URLリクエストに設定されている名前を彼に設定する
    $彼 = new 人($_GET[jp::名前]);
    return $彼-＞名前は();
}
$gr[jp::名前] = 彼の名前();