JavadocでソースコードからAPI仕様書を作成

Javadocとは

コメントからAPI仕様書を作成するツールです。

こんな感じのコメントから、
(一部抜粋)

 

こんな感じのAPI仕様書のWebページを生成します。

コメント

クラスやメソッド、フィールドの上部に以下の形式のコメントを記述します。

 

例:

 

コメントの内容は概要とJavadocタグの2つです。
Javadocタグを記述することで引数や返り値の説明などをWebサイトでうまい具合に表示してくれます。Javadocタグは複数記述することが可能です。

Javadocタグを使ったときの引数の説明

タグ

タグはたくさんありますが、今回使うタグを抜粋して説明します。

タグ名

書き方

記述場所

複数記述

タグの説明

@author

@author [名前]

概要、クラス、パッケージ、インターフェース

著者名

@param

@param [引数名] [引数の説明]

メソッドのみ

引数の説明

@return

@return [返し値の説明]

メソッドのみ

不可

返し値の説明

ドキュメント作成

実際にAPI仕様書を生成してみます。
4つのファイルを用意しました。
下記のように配置しています。doc下にAPI仕様書を生成します。
javadoc
-doc
-src
-example
・Example.java
-hello
・Hello.java
-target
・Target.java
-world
・World.java

・Example.java

 

・Hello.java


・Target.java


・World.java


/javadocで下記のコマンドを実行します。

画像のようなサイトが生成されます。

まとめ

今回はJavadocのよく使う部分だけを抜粋して説明しました。
Javadocができることは他にもたくさんあるので、こういうことがしたいということが結構できると思います。JavadocはJDKに含まれてるのですぐ使えます。
ぜひ試してみてください。

Smallitのサービス