トップ «前の日記(2006-09-07) 最新 次の日記(2006-09-09)» 編集

2006-09-08 [長年日記]

_ (たぶん)いちばん短い phpdoc 生成の覚え書き

なんか今までサクっとコマンドで phpdoc を生成するってのはなぜかやったことがなかったので。

  • CLI 版 PHP バイナリが入っている
  • Pear で PhpDocumentor をインストールしている

状態を想定。以下のように叩く。

php PHPDOC-MODULE -d SOURCEDIR -t OUTPUTDIR

オプションは

-f
parse 対象ファイル名の指定
-d
parse 対象ディレクトリの指定(たぶん、普通使うのはこっち)
-t
HTML などの出力先
-h
ヘルプを出力

-t じゃなくて -o じゃないのかとか、-f と -d を分けるのってちょっとどうなんだとか、CLI 好きとしてはなんか少し他のいろいろあるコマンドと比べてオプションの体系に違和感がある。やっぱもともと Web インターフェイス + 設定ファイル(PHP直書き)という文化圏のツールなんだなぁって感じがしないでもない。

phpdoc のモジュールは OSX 標準の PHP に対して Pear でインストールしたときには /usr/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc にある。alias を設定しておけ。*1と思ったら Debian で入れたら勝手に phpdoc コマンドができた。あれれ。まぁ便利だからいいけど。

しかしこれ未だに多言語対応は考えてないんだな、きっと。iso-8859-1 に決め打った HTML が生成されてしまう。まぁオープンソースものなら Pear の規約に照らし合わせても us-ascii 以外をコード内に入れない方がいいんだろうけど、手元で使う分には日本語書けないとさすがに不便なのよね。

Tags: PHPDoc PHP OSX

*1 みんなに使わせたいなら shell script の方がよい。