ツールを利用してAPIを生成する

PHPDocとPHPXrefを使ってみた。

PHPDocはAPIドキュメントを作ってくれるツールで、PHPXrefはクロスリファレンスを作ってくれるツール。
今更とりあげることでもないけど、これは使うべきツールだと思う。

コメントをルールに従って記述したら、あとはそれに従ったドキュメントを生成してくれる。
ドキュメント生成だけでなく、コメントを注意して書く様になる(文法に従う)ことが重要。
オープンソースとかのコードを見てれば問題ないだろうけど、コメントの書き方はいまいち解らない。
まあ、仕様とか設計とかをじっくりと練り上げないとことか、1つのメソッドを最初から実装しようとするところが一番問題なんだけど。
まずは中身を考えないで、コメントとインターフェース(クラスとかメソッドの枠組み?)だけをくんでいくのが奇麗なやり方なのかな。

ツールの仕様に従うことは割と苦痛を感じたりするけど、これはコードも分かり易くなるし楽できるしでいい感じ。
まだいまいちドキュメンテーションタグの有効な使い方とかが解らないけど、しっかりと勉強していきたい。
もちろん、生産的な開発手段もあわせて身につけていこう。

参考:
PHPDoc
PHPXref
Do You PHP? - PHPDoc - APIドキュメントの自動生成
Do You PHP? - PHPXref - クロスリファレンスドキュメントの自動生成

プロフィール

このブログ記事について

このページは、koshigoeが2005年7月 1日 20:43に書いたブログ記事です。

ひとつ前のブログ記事は「Feedが、、、」です。

次のブログ記事は「OSXとSubversion」です。

最近のコンテンツはインデックスページで見られます。過去に書かれたものはアーカイブのページで見られます。