PHP ソースからドキュメントを自動生成する (doxygen)

PHP ソースからドキュメントを自動生成する (doxygen)
================================================================================

昨日の「PHP ソースからドキュメントを自動生成する (phpdocumentor)」 は、

PHP ソースからドキュメントを自動生成させることができる。
ドキュメントの基になるのは、ドキュメントコメントといわれるもので、
/** で始まり、*/ で終わる形式のコメント。

また、その中に、次のようなタグをつけることで、ドキュメントに対して指示を出すこと
ができる。もちろん、これ以外にもいろいろとある。
---
* @author 作成者
* @version バージョン
* @param 引数名 意味
* @return 戻り値
---

PDT を使っていれば、このドキュメントコメントの基になるものはある程度自動生成する。
(Ctrl+Shift+J)


■インストール

doxygen のサイト
http://www.doxygen.org
http://www.stack.nl/~dimitri/doxygen/

から、ダウンロードのリンクをクリックし、つぎのファイルをダウンロードする。
A binary distribution for Windows 95/98/ME/NT/2000/XP/Vista
doxygen-1.5.8-setup.exe (7.2M)

インストーラーなので、すべてデフォルトでインストールすればよい。


■ドキュメント生成

doxygenwizard を選択して、起動。ウィザードにしたがって設定する。

Step1: doxygen の作業ディレクトリーの指定。適当な場所でOK。

Step2: 生成のパラメータを設定

[Wizard]タブ - [Project]トピック
次を指定する。
[Project name] プロジェクト名
[Source code directory] ソースコードのディレクトリー
[Destination directory] ドキュメントの生成先のディレクトリー

[Wizard]タブ - [Model]トピック
次を指定する。
[All Entries]ボタンをチェック
[Optimiza for C or PHP output]ボタンをチェック

[Wizard]タブ - [Output]トピック
次を指定する。
[HTML]ボタンをチェック
[with frames and a nabigation tree]ボタンをチェック (ただし、これは好み)


[Expert]タブ - [Project]トピック
次を指定する。
[OUTPUT_LANGUAGE] で [Japanese] を選択

[Run]タブ - [Run doxygen]ボタンをクリックすると、ドキュメント生成を行う


■ブラウザーでドキュメントを見る

[Run]タブ - [Show HTML output]ボタンをクリックすると、ドキュメントをブラウザーで確認できる


■参考URL

PHPソースからドキュメントを生成するツール
http://www.1x1.jp/blog/2007/10/php_source_document.html

http://www.doxygen.org
http://www.stack.nl/~dimitri/doxygen/

以上