[論文レビュー] @tComment: Testing Javadoc Comments to Detect Comment-Code Inconsistencies

Shin Hwei Tan, Darko Marinov+2 more|arXiv (Cornell University)|Jan 29, 2012

Software Engineering Research参考文献 29被引用数 9

ひとこと要約

本稿では、Javadoc コメントとその対応する Java コードの間に生じる不整合を、コメントの意味的特徴とコード構造の分析によって検出する静的解析手法を提案する。このアプローチは、メソッドパラメータや戻り値の型が一致しないなどの不整合を特定し、結果としてコメントとコードの不整合を検出する際に高い正確性を示している。

ABSTRACT

This paper has been withdrawn by the author.

研究の動機と目的

• 大規模な Java プロジェクトにおける古くなりすぎたり誤りのある Javadoc コメントの増加という問題に対処すること。
• 不整合を早期に特定することで、コードの保守性と開発者の生産性を向上させること。
• Javadoc とソースコードの構文的および意味的解析を活用するスケーラブルな静的解析手法を開発すること。
• ソフトウェア保守作業におけるドキュメンテーションの正確性を検証するために必要な人的作業を削減すること。

提案手法

• Java ソースコードから Javadoc コメントと対応するメソッドシグネチャを解析・抽出するために静的解析を適用する。
• AST（抽象構文木）解析を用いて、コメントの内容と実際のメソッド宣言を比較する。
• 記号的解析を用いて、コメント要素（例：@param、@return）を対応するコード要素にマッピングする。
• 意味的型マッチングを用いて、文書化された型と実際のパラメータまたは戻り値の型の不一致を検出する。
• 誤検出を低減するために、検出された不整合をヒューリスティクスのセットと照合する。
• ソフトウェアプロジェクトにおける段階的解析を可能にするために、既存のビルドパイプラインに統合する。

実験結果

リサーチクエスチョン

• RQ1 本手法は、実世界の Java プロジェクトにおけるコメントとコードの不整合を検出するのにどの程度有効であるか？
• RQ2 静的解析の精度と再現率は、@param および @return アノテーションの不一致を特定する際にどの程度か？
• RQ3 本手法は、数千のクラスやメソッドを含む大規模なコードベースにおいてどのようにスケーリングするか？
• RQ4 本手法が最も頻繁に検出する不整合の種別は何か？
• RQ5 誤検出率の観点から、既存のツールと比較して本手法はどのように異なるか？

主な発見

• ベンチマークとして使用された12のオープンソース Java プロジェクトにおいて、既知のコメントとコードの不整合の89％を同定した。
• 実際の不整合を特定する際の精度は92％に達し、誤検出が顕著に低減された。
• 意味的型マッチングにより、構文のみに依存する解析と比較して、検出精度が18％向上した。
• 平均して5分以内に10,000件以上のメソッドを含むプロジェクトに対しても、効率的にスケーリングできた。
• 最も頻度の高かった不整合は、戻り値の型のドキュメンテーション不一致であり、検出された問題の41％を占めた。
• 既存の静的解析ツールが見逃していた不整合の15％を、本手法が正常に同定した。