meraの日記: PHPDoc
日記 by
mera
何気にJava勉強中に覚えたJavadocがあまりにも美味しすぎるのでPHPでも自動ドキュメント生成ソフツは無いものかと探していたらPHPDocというのがありました。 ふんふん、PEARのソースコードはこれでドキュメント吐けるような書式で書かれてんのね、というわけで早速スクリプトをダウンロードしてインストール! 使ってみた感想は
・スクリプトはインクルードファイル形式というかrequireして呼び出す
・サンプルはApache経由で起動させるスクリプトしかないので不便かも。コマンドライン版はすぐ作れそう
・基本的に海外の人が作ったので日本語コメント吐くと化ける
・Javadocを意識してるのかpackageという概念がある
・つべこべ言わずに使え! とコンバートしてみたらかなりいい感じ
というわけで今度からソースコードを書いてドキュメントを更新してという作業からは開放されたのでした。 ただこのままじゃちと不便なところがあるので多少カスタマイズ。
・renderer/html/templates/ 以下のテンプレートを修正し、charsetをEUC-JPに変更
・ついでに各テンプレートのメニューを日本語に修正
・区切り記号が<hr>だけで寂しいのでカラフルにしてちょっと見やすく修正
してみました。あぁ、いかんいかん、ドキュメント作成だけで時間食ってしまふ。 他にもPHPDocのソースコードを眺めているといろいろ文書処理やらXML処理やらでかなり参考になるのでしばらくこれで勉強させてもらえそうな感じ。作者に感謝感謝。
・スクリプトはインクルードファイル形式というかrequireして呼び出す
・サンプルはApache経由で起動させるスクリプトしかないので不便かも。コマンドライン版はすぐ作れそう
・基本的に海外の人が作ったので日本語コメント吐くと化ける
・Javadocを意識してるのかpackageという概念がある
・つべこべ言わずに使え! とコンバートしてみたらかなりいい感じ
というわけで今度からソースコードを書いてドキュメントを更新してという作業からは開放されたのでした。 ただこのままじゃちと不便なところがあるので多少カスタマイズ。
・renderer/html/templates/ 以下のテンプレートを修正し、charsetをEUC-JPに変更
・ついでに各テンプレートのメニューを日本語に修正
・区切り記号が<hr>だけで寂しいのでカラフルにしてちょっと見やすく修正
してみました。あぁ、いかんいかん、ドキュメント作成だけで時間食ってしまふ。 他にもPHPDocのソースコードを眺めているといろいろ文書処理やらXML処理やらでかなり参考になるのでしばらくこれで勉強させてもらえそうな感じ。作者に感謝感謝。
PHPDoc More ログイン