PhpDocumentorはプログラムソースからリファレンスを生成することができるツールです。
プログラムソースのコメントからリファレンスを生成します。
HTMLやPDFにアウトプットすることができます。
■インストール
Ubuntuパッケージ
$sudo apt-get install
Linuxソース
ここからDLして
unzip xxx.zip
cd xxx
./configure;make;make install;
■クラスのコメントの書き方
/** * ログインクラス（クラスの論理名） * * ログインに関する機能を有するクラス（クラスの説明） * * @package パッケージ名 * @author 著作者 <著作者メール> * @since 2009/07/27 * @version $Id: login.class.php,v 1.0 2009/07/27 20:15:32 xxx Exp $ */
■メソッド、関数のコメントの書き方
/** * loginチェック（メソッドの説明） * * @param string $arg ユーザー名 * @param integer $arg2 パスワード * @return string 1:LoginOK 0:LogniNG */
■ドキュメント生成
phpdoc -t ./ドキュメント保存先 -d ./ソースディレクトリ
$ cd sourceディレクトリ
$ mkdir doc
$ phpdoc -t ./doc -d ./* -o HTML:Smarty:PHP
// -o HTML:Smarty:PHP を指定するとUTF-8のソースで文字化け無く見れます
■マニュアル
・PEAR
・phpDocumentor
このブログで関連すると思われる他の投稿
