phpDocumentor用コメントの書き方

phpDocumentor 用というわけではありませんが、こういう感じにコメントを書きましょう、というのがあります。

関数/メソッドの場合

例えば、

function hoge($arg,$arg2){}

という関数があったとして、
第一引数の型が文字列型、$arg2 の型が整数型だった場合で、戻り値が配列型であった場合、コメントは、

/**
* hogeの説明
*
* @param string $arg 第一引数
* @param integer $arg2 第二引数
* @return array 戻り値の説明
*/

のようになります。

型として、string や integer のほかに、object(オブジェクト), array, mixed(いろんな型が返る場合), resource(リソース型) といったものが使えます。

オブジェクトのメソッドの場合は、アクセス修飾子として、

@access public
@access private
@access protected

をのいずれか指定しておいた方がよいでしょう。

変数/define定数

/**
* 説明
* @see 関連関数1,関連関数2
*/

のように書きます。

クラスの場合

/**
* クラスの説明
*
* @package パッケージ名
* @author 著作者 <著作者メール>
* @since PHP 4.0
* @version $Id: DB.php,v 1.58 2004/03/13 16:17:19 danielc Exp $
*/

こういう感じに書きましょう。

実際には、PEAR のクラスなどが参考になりますので、きちんとしたものが見たい場合はそちらをご覧下さい。

スポンサードリンク

もどる