2009-06-05

phpdoc の出力が使いにくい

phpdoc と自分が呼ぶ場合は

phpDocumentor: The complete documentation solution for PHP

のこと。

pear install PhpDocumentor

で入るもの。

で、これを毎日回して trunk の code の apidoc を自動生成してるんだけど、この際、どのファイルを parse してるとか書き出してるといった様子が全部 stdout に吐かれる。そう、全部。

  • Hidden(読み込まないファイル)
  • Reading
  • Proccessing
  • Sorting
  • Formatting
  • Building
  • Writing
  • WARNING
  • ERROR

全部ぜーんぶ。鬱陶しい? オプションを紹介しよう。

 -q    --quiet                   do not display parsing/conversion messages.
                                 Useful for cron jobs on/off default off

だけ。on か off しかないの。

こういう情報って、とりあえず ERROR だけ欲しいよねぇ。ERROR 起きてたらそれを通知するとか、そういう使い方するもんでしょ? この吐き方はどうも、作ってる人もこの情報活用してない感じがする。これじゃー開発時にも自分の欲しい情報をすぐ取り出せないっしょ。

うーん。どうしようね。awk とか絡めて何か作るしかないのか…。いや、普段自分は気をつけて commit しているのであんまり ERROR 起きないんだけど、気をつけなきゃいけないのがダサイし、自分と同じ気をつけレベルを他人に強要、いや期待する段階でダサイし、現状はとにかく不確実である。

確実な動作を検証する方法があるはずの不確実なものに人間の注意で対応するのは我々の仕事としてはダメでしょう。

cf. Twitter / wtnabe: phpdoc の log ってこれ絶対作った人使って …

About

例によって個人のなんちゃらです