プログラム見ればわかるだろうと言う嗜好だったので、標準的なプログラムドキュメントを残す癖があまりなかったり。。。

ソースをパースしてるだけぽいので自分で作っても良かったが、割いてる時間がないのでサードパティのを使ってみる。 合間にちょっと調べたらPHPDoc がなくなってしまったようで、その代わりに phpDocumentor があるようです。

インストール

ソースを本家からダウンロードするか、Pearでインストール

pear install --alldeps phpdocumentor

実行

/**
 * 問い合わせページ
 *
 * @package com.yoo-s
 * @author  Yohei Yoshikawa
 * @create  2011/09/15
 */

・・・・

    /**
     * トップページ
     *
     * @params
     * @return void
     */
     function index() {
     }

みたいな感じでドキュメントを記述記述

phpdoc -t ./doc -d ./app -o

-t で書き出し先を指定し、-d でプログラムソース指定

HTMLで出力されるが、個人的にはちょっと使い勝手が悪いかな？と思ったり。 いちいち静的に書き出すのではなく、ブラウザ上で動的に表示してボタン一つでその社風にあったドキュメントをまとめられれば理想なんですけどね。

ちょっと自作も検討しようかな？と思いましたが・・・まぁ、ないよりはマシかな？とは思います。