スマートフォンやhtml5+CSS3など新技術に四苦八苦。jQuery、AjaxなどJavaScriptも難しいですね。そんなWebに悩む人のネタ帳です。

phpDocumentorでPHPのドキュメントを作成

update : 2008/12/06

最近、PHPの開発に携わる機会が多く、自分の今後のためにと、関数軍をなるべく再利用できるように蓄積しています。しかし、単にコメントをつけて、phpファイルを整理しているつもりでも、後々何がどこにあるやら分からなくなります。
javaにjavadocがあるように、phpにもそのしくみがないものかと探してみたら、見つけました。
phpDocumentor


使い方はいたって簡単。
上記サイトより「PhpDocumentor-1.4.2.zip」をダウンロードして展開。
コマンドラインより、展開ディレクトリに移動し、下のコマンドを実行します。

(PHPのインストールフォルダ)/php.exe phpdoc -d (入力元となるphpソースがあるディレクトリ) -t (ドキュメントの出力先)

例えばこんな感じです。

C:phpphp.exe phpdoc -d C:input -t C:output

ここで、しっかしとしたコメントを記述していればしているほど、良いドキュメントが生成されます。
コメントルールについては本家サイトを参照してください。javadocを書いている人やeclipseを使っている人にとってはお馴染みのルールです。

一点注意が必要なのは、デフォルトだと文字化けするということです。これについては、以下のディレクトリのテンプレートを日本語にセットし直す必要があります。

...PhpDocumentorphpDocumentorConvertersHTMLframestemplatesdefaulttemplates*

具体的には各ファイルの「charset=iso-8859-1」となっているところを「charset=utf-8」などに編集します。探すのがめんどくさいので、grepなどのツールを利用しましょう。

設定ファイルが用意されているので、ほかにもいろいろとできそうです。
しばらくいじってみたいと思います。

B!

Reference

Comment

Comment Form

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください

Monthly Archives