phpDocumentor - phpspot

プログラムでドキュメントを書くのって面倒ですよね。

そこで javadoc 風なドキュメントを作成してくれる phpDocumentor の紹介です。

スクリプト中に

/**
* 概要
* phpDocumentorのサンプルです
*
* 説明
* phpDocumentorによって作成されました。
*
* @param string $arg 説明
*
* @return string 説明
*/
function PACKAGE_fooFunc(){

}

のような感じでコメントを書いておけばドキュメント化してくれます。

phpDocumentor用コメントの書き方

インストール
phpDocumentor は pear でもインストールできますが、
今回は本家からファイルをダウンロードして進めます。
まず、ここからダウンロードします。

Windowsの方は zip , UNIXの方は tar.gz をダウンロードしてください。

解凍すると、

のようにファイルが沢山できます。
(Windowsの場合。Unixでも同様です)

このディレクトリに、
phpDocumentor.ini があるので、

[_phpDocumentor_phpfile_exts] で取り込みたいファイルの拡張子を指定したりできます。

ドキュメントの作成
次に、ドキュメントを作成したいプログラムのソースを
同じディレクトリに
src\ を作ってその下に置いてみましょう。

あと、同じディレクトリにドキュメント出力先として、 doc\ ディレクトリを作成しましょう。

↑こんな感じにフォルダを２個作成しました。
src\ 内にドキュメントを作りたいphpのソースコードを。
doc\ はドキュメントを作成するディレクトリです。

ここで、同じディレクトリにtmp.txtファイルを作成します。

ファイル内には、

php phpdoc -d ./src/ -t ./doc/

のように書いてください。
　-d でソースディレクトリを、-t でドキュメント出力先を指定しています。

※phpのパスはローカルの php.exe または、php-cli.exe の名前を指定します。XAMPP や phpdev をお使いの方は以下の例をご覧下さい。

XAMPP の場合、
C:\Program Files\xampp\php\php4\phpcli.exe phpdoc -d ./src/ -t ./doc/

phpdev の場合、
C:\phpdev\php\php-cli.exe phpdoc -d ./src/ -t ./doc/

を指定します。

保存したら、tmp.txt のファイル名を exec.bat と名前を変更して、exec.bat をダブルクリックしてください。(Unixの場合はシェルスクリプトとして作成し、それを実行してください)

これで doc 以下にドキュメントが作成されます。

ソースファイル数によって時間が結構かかることがあります。
ドキュメント作成後、みてみると、日本語が文字化けしてしまいます。

次のページでは、この文字化け対策法を紹介します。

スポンサードリンク

→次のページ