PHPのドキュメント
ファイル、クラス、メソッドのドキュメントブロックについて
Zend Framework PHP 標準コーディング規約及び、 Manual :: Coding Standardsを参考。
以前はPear Manual :: 標準コーディング規約(日本語版)が存在していたのですが、消滅してしまったようです。
ファイル
/**
* ファイルについて短い説明
*
* ファイルについて長い説明
*
* @package パッケージ名
* @copyright コピーライト
* @version$Id:$
*/
クラス
/**
* クラスについて短い説明
*
* クラスについて長い説明
*
* @package パッケージ名
* @version$Id:$
*/
class foo
{
}
メソッド
/**
* メソッドについて短い説明
*
* メソッドについて長い説明
*
* @param 形式 パラメタ
* @return 戻り値
*/
public function foo($arg1, $arg2 = '')
{
}