PHPDoc †
ツール †
- PHPDocという記述形式でコメントを書いておくと、コメント部分をまとめてドキュメント生成してくれる
- PHPのソースコードから、例えば、HTML形式でAPIドキュメントを生成するためのドキュメントジェネレータ
- C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、PHP、C# 向けのドキュメンテーション・システム
- 文書化されたソースファイルのセットから、 オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (形式) を生成することができる
- RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポート
- ドキュメントは、ソースから直接抽出される
- Doxygen は、文書化されていないソースファイルから、 コードの構造を抽出するように設定することができる
- 様々な要素間の関係が、内包・依存図、継承図、 およびコラボレーション図により視覚化される(しかもすべて自動的に生成される)
- Doxygen を「乱用 (abuse)」して、 通常のドキュメントを作成することもできる