動作原理

動作原理

ドキュメントの解析情報の生成は、二段階に分けて行われます。

1. データを収集し、保存する

2. 保存されたデータをもとに、さまざまなレポートを生成する

なぜこのようにしたかというと、データの収集には長い時間 (約一分) がかかり、しかもこれはレポートの種類ごとに必要だったからです。 つまり、シンプルなドキュメント網羅状況のほかに拡張版のレポートがほしければ、 共通のデータをそれぞれに用意し、それを単に異なる切り口で見せるだけとなります。

QA_Peardoc_Coverage にある generateCoverage() は、網羅状況のデータを算出してそれを配列で返します。 これはシリアライズして保存することができ、すべての Renderer クラスで、それを入力として使用することができます。

QA_Peardoc_Coverage_Renderer インターフェイスを実装したクラスは render() メソッドを提供します。 これは generateCoverage() が返すデータを受け取り、 解析結果を返します。この結果は、たいていの場合は HTML を含む文字列となります。