網羅状況の生成

網羅状況の生成 – 順を追って説明します

網羅状況の解析データの生成

  1. cvs.php.net からチェックアウトした pear ディレクトリおよび peardoc ディレクトリが存在することを確認します。

  2. peardoc の configure を行い、 manual.xml を作成します (autoconf, ./configure)。

  3. genData.php をコールします。最初の引数に peardoc の manual.xml へのパス、 二番目の引数にはチェックアウトした pear ディレクトリへのパスを指定します。

  4. doc.dat という名前のファイルが、 作業ディレクトリに出来上がります。

HTML レポートの生成

データの作成とシリアライズがすんだら、HTML のレポートを作成することができます。 レポート作成用に、このパッケージでは四種類の Renderer クラスを提供しています。これらはすべて QA_Peardoc_Coverage_Renderer インターフェイスを実装したものです。

  • QA_Peardoc_Coverage_Renderer_DeveloperList は、開発者別に「パッケージの数」「ドキュメントが存在しないパッケージの数」 「ドキュメントが存在しないパッケージの一覧」をまとめます。 ドキュメントが作成されているパッケージの割合が大きい順に並べ替えられます。

  • QA_Peardoc_Coverage_Renderer_SimplePackageList は、PEAR のカテゴリごとにすべてのパッケージを並べ、 どのパッケージにドキュメントが存在してどのパッケージにドキュメントが存在しないかを示します。 最後に「パッケージの総数」「ドキュメントが存在するパッケージの数」 「ドキュメントの網羅率」がまとめられます。

  • QA_Peardoc_Coverage_Renderer_ExtendetPackageList は上の単純なリストと似ていますが、パッケージだけでなく パッケージ内のクラス、クラスのメソッド単位でのドキュメントの状況を表示します。 これを使用すると、あなたが書いたドキュメントで まだ網羅されていないメソッドがどれかがわかります。

  • QA_Peardoc_Coverage_Renderer_MissingDocsPerDeveloper は、developer email => array(package names) 形式の配列を作成します。 開発者に対して確認のメールを送るための元データとして使用します。

すべてのレンダラには examples/gen*.php ファイルが存在します。これらは、examples/genData.php が書き出す doc.dat ファイルを使用します。 結果は html 形式でコンソールに出力されるので、 それをリダイレクトしてファイルに保存します。

全般的な解説 (Previous) QA_Pear_PackageStatus (Next)
Last updated: Wed, 26 Nov 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.