Java言語のAPIドキュメント作成支援ツールの提案と実装

摘要

Javaではjavadocにより,ソースコード中のコメントをもとに,Webブラウザで表示可能なHTMLベースのAPIドキュメントを生成する事が出来る.しかしながら,javadocはソースコードとコメントの内容の整合性の確認はしてくれない.また,コメントに記述した内容が,どのようなHTML文書に変換され,どのようにブラウザで表示されるのかを想像しながら編集しなければならない点も不便である.本稿では,これらの問題を解決するため,コメントやHTMLの記述を意識することなく,ブラウザで表示されたAPIドキュメントベースでコメント編集を可能とすると同時に,ソースコードとコメントの整合性を検証するツールを提案し,その実装について述べる.