私は、パブリック API ドキュメントが明確な成果物であるプロジェクトに携わっています。リリースがこの要件を確実に満たすようにするために、ドキュメント カバレッジが低すぎる場合、Ant ビルド ファイルのリリース ターゲットが失敗するようにしたいと考えています。
少なくとも、公開アクセスまたは保護アクセスを持つ各識別子には、適切な Javadoc タグと説明が必要です。たとえば、パブリック メソッドには、@param各パラメーターの@returnタグ、戻り値の型が でないvoid場合の@throwsタグ、各例外のタグ、および 1 行の説明が必要です。
私は現在、Cobertura を使用した JUnit コード カバレッジ レポートと障害状況を持っているので、ドキュメントと同様のものが最適です。ただし、障害状態の検出が利用できない場合は、レポートが妥当な代替手段となります。
ドキュメントは Javadoc 形式である必要があります。Doxygen を含む他の形式は受け入れられません。