ZendFramework >> 4.インラインドキュメント - zendframework @ ウィキ

4.インラインドキュメント

ドキュメントブロックは「phpDocumenter」と互換性のある書式でなければなりません。
記述が義務付けられているのは、ファイルレベル、クラスレベル、メソッドレベルです。

ファイルレベルでの「phpDocumenterタグ」を含むヘッダブロック

/**
* ファイルについての短い説明
* 
* ファイルについての長い説明（もしあれば）
*
* LICENSE: ライセンスに関する情報
*
* @copyright 2007 Zend Tecnologies Co.,Ltd.
* @license ライセンスについて説明しているURLなどを記述
* @version x.x.x
* @link このプログラムについて紹介しているURLなどを記述
*@sice File available sice Release x.x.x
*/

クラスレベル

各クラスには、最低限これらの「phpDocumenterタグ」を含むヘッダブロックをクラス名の前に記述しなければなりません。

/**
* クラスについての短い説明
* 
* クラスについての長い説明（もしあれば）
*
* LICENSE: ライセンスに関する情報
*
* @copyright 2007 Zend Tecnologies Co.,Ltd.
* @license ライセンスについて説明しているURLなどを記述
* @version x.x.x
* @link このプログラムについて紹介しているURLなどを記述
*@sice File available sice Release x.x.x
*/

メソッドレベル

各関数には、最低限これらの「phpDocumenterタグ」を含むヘッダブロックをクラス名の前に記述しなければなりません。

/**
* 関数についての短い説明
* 
*
* @param データ型　引数1
* @param データ型　引数2
* @param データ型　引数3
* @return データ型　
*/

関数が例外をスローする場合には「@throws」を使用します。

@throws exceptionclass [description]