Javadocの利用

Javaのソースコードからクラス仕様書を生成するツール。特定書式で書いたコメントを仕様書内に挿入できる。

準備

• クラスのファイルを全て作成する。
• フィールドを定義する。
• メソッドを定義する。ただし、中身は書かない。
• 戻り値があるメソッドの場合、エラーになるので、return で適当な値を返す（intなら0、クラスならnull）。

Javadoc用のコメント

/** から */ までのコメントがjavadocに入る。

クラス、フィールド、メソッドの上にコメントを付ける

クラスやフィールドの上にはその説明を入れる

/**
 * 商品クラス
 * @author kohara
 *
 */
public class Shouhin {
	/** 
	 * 商品ID
	 */
	private int sid;

引数があるメソッドの上には@paramの後に各引数の説明を入れる。（eclipseでは自動的に@paramが入る）

	/**
	 * コンストラクタ
	 * @param sid 商品ID
	 * @param sname 商品名
	 * @param tanka 単価
	 */
	public Shouhin(int sid, String sname, int tanka) {
		this.sid = sid;
		this.sname = sname;
		this.tanka = tanka;
	}

戻り値があるメソッドの上には@return の後に戻り値の説明を入れる。（eclipseでは自動的に@returnが入る）

	/**
	 * 商品IDを返す
	 * @return 商品ID
	 */
	public int getSid() {
		return sid;
	}

１．プロジェクトを右クリックし[エクスポート]-[エクスポート]を選ぶ。

２．エクスポートの画面でJavaの下にあるJavadocを選び次へを押す。

３．「次の可視性を持つメンバーのJavadocを作成」で private を選び完了を押す。

これでプロジェクト配下にdocというフォルダが出き、そこにHTMLファイルが生成される。

１．プロジェクト配下にdocフォルダを右クリックし[Windowsエクスプローラ]を選ぶ。

２．フォルダが表示されるので、index.htmlをダブルクリックする。