[PHP-users 12800] Re: phpdocの利用可能タグについて

Mashiki php-users@php.gr.jp
Sat, 25 Jan 2003 01:23:55 +0900


 Mashikiです。

>余談ですが今から PHPDoc をご利用なさる場合は、同じく PEAR に入っている
>PhpDocumentor の方も検討されては如何でしょうか。
>http://pear.php.net/package-info.php?pacid=137
>http://phpdocu.sourceforge.net/
>
>PEAR の Description からの抜粋ですが、
>It differs from PHPDoc in that it is much faster, parses a much wider
>range of php files, and comes with many customizations including 10
>HTML templates, windows help file CHM output, PDF output, and XML
>DocBook peardoc2 output for use with documenting PEAR.
>
>ということで利用価値は高そうです。

 早速、使ってみましたが、これすごいですね。

 実は今日初めてphpdocをインストールして使ったのですが、
複数のディレクトリに分けて管理されているクラスの定義を
ドキュメント化するのに適当な方法が見つかりませんでした。
また、お手本どおりにコメントを作成しても、ドキュメントに
反映されない場合などあって悩んだりもしていて、紹介して
いただいた、PhpDocumentorに乗り換えてみました。

結果はばっちりです。上記2点の問題もクリアされています。
最初はなぜ照会文にphpdocより速いとうたわれているのに、
5倍以上時間がかかるんだろうと悩みましたが、デフォルトで
10種類くらいのタイプのドキュメントを作っているのですね。
PDFまで作っていたのには驚きです。でもとりあえず開発機が
低スペックなので、出力タイプの数を減らして満足できる速度
を得ることができました。

# phpのマニュアルそっくりな出力様式がちょっと気に入った
# かな?全部は見れてません。

ソース中のコメントの書き方もphpdocの上位コンパチになって
いるようで、無修正でphpdocより詳しい出力を得ることができ、
またコマンドラインばかりでなくwebからのドキュメント作成の
キックもできるので、秀丸+samba+php使いの現在の開発チーム
とも相性がよさそうです。

 インストールは開発機にtar.gzを展開してドキュメントルート
配下のディレクトリにコピーし、default.iniを書き換え、出力先の
ディレクトリをapache実行ユーザーから書き込み可能にし、
*なぜか*パッケージをコピーしたディレクトリ配下にも実行時に
新たにディレクトリを作りたがるようで、気持ち悪いのですが、
コピーしたディレクトリ配下をapache実行ユーザーから書き込み
可能にしました。
# 公開してないサーバーだから動けばいいという感覚です。あまり
# ドキュメントを読んでいないので間違っていると思います。

久保さん、情報ありがとうございます。感謝、感謝です。
牛島さんも試してみる価値がきっとあると思います。