導入

導入 -- QA_Peardoc_Coverage の利点

QA_Peardoc_Coverage について

どんなにすばらしいライブラリでも、ドキュメントがなければ使いようがありません。 PEAR には 300 を超えるパッケージがあり、自動生成される API ドキュメントとマニュアルが存在します。PEAR マニュアル (今あなたがご覧になっているものです) には、 それらのパッケージの概要や使用法、 そしてパッケージを構成するクラスや そのメソッドについて理解を深めるための情報が掲載されています。 さらなる情報が必要な場合は API ドキュメントを調べます。

PEAR パッケージの量は膨大なので、 それぞれのドキュメントの状態を管理するのは大変です。 何らかのツールが必要でしょう。 QA_Peardoc_Coverage こそがそれを実際に形にしたものなのです。

QA_Peardoc_Coverage は CVS から PEAR と PEARDOC をチェックアウトします。それをもとにして、 「どのパッケージのドキュメントが存在するのか」 「どのクラスのどのメソッドのドキュメントが存在するのか」 「きちんとドキュメントを作成している立派な開発者は誰なのか」 といったことを調べます。