はじめてのjavadoc

java

最近はPODドキュメントを書くことが多いのだけれど，確かJavaにはもっと綺麗なjavadocがあったはず．ということで，使い方を知ろう知ろうと思っていたjavadocを勉強してみた．といってもめちゃくちゃ簡単だった．

基本事項

  • 「/**」で始まり，「*/」で終わる
  • コメントの行頭は*ではじめる？

使うタグ

クラスの
  • @author
  • @version
メソッドの
  • @param
  • @return

これだけ覚えれば十分．paramについては，

    /**
     * Constructs Prac1 instance
     * @param value value of hoge
     * @param name name of hoge
     */
    Prac1(int value, String name){...

というように表記すれば．

Parameters:
 value - value of hoge
 name - name of hoge

自分はあんまり使わないと思われるタグ

  • @throws　発生する例外
  • @see　SEE ALSO
  • @deprecated　推奨されないAPI

Javadoc生成には以下のようなコマンドを実行

% javadoc -d ./doc Hoge.java

dオプションは出力先のディレクトリを指定．どうやらpublicクラスじゃないと生成してくれないっぽい．（オプションが必要？？）


すると，こんな感じのJavadocが出力される．


以下，元のソースコード

/**
 * Practice class
 * @author sleepy_yoshi
 * @version 1.0
 */
public class Prac1{
    
    private int value;
    private String name;

    /**
     * Constructs Prac1 instance
     * @param value value of hoge
     * @param name name of hoge
     */
    Prac1(int value, String name){
	this.value = value;
	this.name = name;
    }

    /**
     * Returns value
     * @return value
     */
    public int getValue(){
	return this.value;
    }

    /**
     * Set name
     * @param name name of hoge
     */
    public void setName(String name){
	this.name = name;
    }

    /**
     * Print all parameters
     */
    public void printAll(){
	System.out.println(this.value);
	System.out.println(this.name);
    }

    public static void main(String args[]){
	Prac1 p = new Prac1(1, "hoge");
	p.printAll();
    }
}