phpDocumentor用書式

今更ながら、phpDocumentor利用時に必要なコメント書式

  • こんな感じ 
<?php
/**
 * aaaの説明
 *
 * @param string $arg 第一引数
 * @param integer $arg2 第二引数
 * @return array 戻り値の説明
 */
function aaa($arg,$arg2)
{
}
/**
 * 説明
 * @see 関連関数
 */
/**
 * クラスの説明
 *
 * @package PackageName
 * @author $Auth$
 * @version 1.0.0-x
 */
 
?> 
 
  • ほか、利用可能なパラメータ
@abstract
@final
@access public
@author Masaru Hashizume
@copyright Copyright (c) 2002, Masaru Hashizume
@param bool $baz
@return mixed
@version 1.00
@see function parent_method
@since 2009/03/01