付録 B. Zend Framework PHP 標準コーディング規約

目次

B.1. 概要
B.1.1. 対象範囲
B.1.2. 目標
B.2. PHP ファイルの書式
B.2.1. 全般
B.2.2. 字下げ
B.2.3. 1 行の長さ
B.2.4. 行末
B.3. 命名規約
B.3.1. クラス
B.3.2. ファイル名
B.3.3. 関数およびメソッド
B.3.4. 変数
B.3.5. 定数
B.4. コーディングスタイル
B.4.1. PHP コードの境界
B.4.2. 文字列
B.4.2.1. 文字列リテラル
B.4.2.2. アポストロフィを含む文字列リテラル
B.4.2.3. 変数の展開
B.4.2.4. 文字列の連結
B.4.3. 配列
B.4.3.1. 数値添字の配列
B.4.3.2. 連想配列
B.4.4. クラス
B.4.4.1. クラス宣言
B.4.4.2. クラスのメンバ変数
B.4.5. 関数およびメソッド
B.4.5.1. 関数およびメソッドの宣言
B.4.5.2. 関数およびメソッドの使用法
B.4.6. 制御構造
B.4.6.1. If/Else/Elseif
B.4.6.2. Switch
B.4.7. インラインドキュメント
B.4.7.1. ドキュメントの書式
B.4.7.2. ファイル
B.4.7.3. クラス
B.4.7.4. 関数

B.1. 概要

B.1.1. 対象範囲

このドキュメントは、Zend Framework に貢献してくださる開発者個人 (あるいはチーム) のためにコードの書式やドキュメント作成の指針を示すものです。 Zend Framework を用いて開発をする人たちにとってもこのコーディング規約は有用でしょう。 これに従えば、Zend Framework のコードとの一貫性が保てるからです。 そのためには、ここで完全なコーディング規約を示す必要があります。 注意: 詳細なレベルまでの設計指針を示すこと以上に、 それを標準規格として確立することが大切だと考えています。 Zend Framework コーディング規約の指針は、 これまで ZF プロジェクトでうまく回っていた方針をまとめたものです。 このライセンスのもとで、 そのまま使用するなり多少変更して使用するなりすることができます。

ZF コーディング規約では、次のような内容を扱います。

  • PHP ファイルの書式

  • 命名規約

  • コーディングスタイル

  • インラインドキュメント

B.1.2. 目標

どのような開発プロジェクトであっても、コーディング規約は重要です。 特に、複数の開発者が参加するプロジェクトならなおさらです。コーディング規約に従うことで、 コードの品質保持・バグの減少・保守の容易性の確保 などの助けになります。