| 講演抄録/キーワード |
| 講演名 |
2007-08-02 15:45
Java言語のAPIドキュメント作成支援ツールの提案と実装 ○橋本和明・杉山安洋(日大) SS2007-20 |
| 抄録 |
(和) |
Javaではjavadocにより,ソースコード中のコメントをもとに,Webブラウザで表示可能なHTMLベースのAPIドキュメントを生成する事が出来る.しかしながら,javadocはソースコードとコメントの内容の整合性の確認はしてくれない.また,コメントに記述した内容が,どのようなHTML文書に変換され,どのようにブラウザで表示されるのかを想像しながら編集しなければならない点も不便である.本稿では,これらの問題を解決するため,コメントやHTMLの記述を意識することなく,ブラウザで表示されたAPIドキュメントベースでコメント編集を可能とすると同時に,ソースコードとコメントの整合性を検証するツールを提案し,その実装について述べる. |
| (英) |
Javadoc is a tool to generate HTML-formatted API documents, which can be viewed on Web browsers, from comments written in Java source code. But javadoc doesn't check the consistency between the source code and the corresponding comments. Moreover, it is inconvenient that users of javadoc need to edit the comments in the source code while imagining the conversion results in HTML and how they are displayed on Web browsers. This paper presents a tool that allows users of javadoc to edit their documentation comments by directly editing the API documents on Web browsers, while keeping the consistency between the source code and the corresponding comments. |
| キーワード |
(和) |
APIドキュメント / 構文エディタ / Java / javadoc / / / / |
| (英) |
API Documentation / Syntax-directed Editor / Java / javadoc / / / / |
| 文献情報 |
信学技報, vol. 107, no. 176, SS2007-20, pp. 25-30, 2007年8月. |
| 資料番号 |
SS2007-20 |
| 発行日 |
2007-07-26 (SS) |
| ISSN |
Print edition: ISSN 0913-5685 Online edition: ISSN 2432-6380 |
著作権に ついて |
技術研究報告に掲載された論文の著作権は電子情報通信学会に帰属します.(許諾番号:10GA0019/12GB0052/13GB0056/17GB0034/18GB0034) |
| PDFダウンロード |
SS2007-20 |