インストール †
PHP5には1.3.0RC3から対応
# pear install http://pear.php.net/get/PhpDocumentor-1.3.0RC5.tgz # pear install --alldeps XML_Beautifier
ドキュメント作成 †
- [-t] ドキュメントを出力するディレクトリ
- [-d] PHPソースがあるディレクトリ 複数の場合はカンマ区切り
- [-o] 出力用テンプレート [出力形式：コンバータ：テンプレートディレクトリ名]
# phpdoc -t ./php_document/ -d /php_source/ -o HTML:Smarty:PHP
主要タグ説明 †
@access †
public, privateいずれか
@author †
/** * @author 作者 */
@copyright †
/** * @copyright Copyright © 2006 yassu */
@global †
グローバル変数について記述
/** * @global test $GLOBALS['bar'] * @name $bar */ $GLOBALS['bar'] = new test
@link †
ハイパーリンクを記述
/** * @link http://yassu.jp/ */
@package †
パッケージ名
@param †
[型]、[名前]、[説明]を記述
/** * @param int $age 年齢 * @return boolean 成功したら TRUE を返す */
@return †
[型]、[説明]を記述
@see †
関連する変数,関数を記述すると自動的にリンクしてくれる
/** * @see SelectAge(), UpdateAge() */
@var †
変数の型を記述
@version †
バージョン情報。CVS の $Revision$ タグ等
/** * @version $Revision: 1.00 $ */
実践 †
クラス †
/**
* 説明
*
* @author 作者
* @version $Revision: 1.00 $
* @package Hoge
* @see http://yassu.jp/
*/
class Hoge {
}
変数 †
/** * 説明 * * @var int * @see SelectAge(), UpdateAge() */ var $age = 34;
関数 †
/**
* 説明
*
* 詳細説明
*
* @access public
* @see SelectAge()
* @param int $age 年齢
* @return boolean 成功したら TRUE を返す
*/
function SelectAge($age)
{
return TRUE;
}
型 †
boolean †
論理値 TRUE or FALSE
integer †
整数
float †
浮動小数点数 double
string †
文字列
array †
配列
object †
オブジェクト
resource †
リソース
@see
NULL †
mixed †
引数に多様な型を使うことができることを示す
number †
integer or float
callback †
