Java基礎ーコメントとJavadoc

コメントとJavaDoc

コメント：ソースコード内に、コードをぱっと見ただけでは伝わらなさそうなことをメモ書きとして残しておく

// これは1行のコメントを書ける

/* 複数行の場合はこっちを使う
これはただのコメントです
*/

JavaDoc：クラスやメンバ変数、メソッドの説明を記述するコメント。

コマンドを打つことでコメントをHTMLファイルに出力することができるので、別途メソッドの説明を記述したドキュメントを作成しなくてもよくなる。

Javadoc出力例

/**
* Javadocサンプル用のクラス。<br>
*/
public class Sample {
    /** メンバ変数 */
    privte String firstName;

    /**
    * サンプル用メソッド。<br>
    * 
    * @param lastName 名前
    * @return フルネーム
    * @throws SomeException lastNameがnullだった場合
    */
    public String doSomething(String lastName)　throws　SomeException {
        System.out.println(lastName);
        return firstName + lastName;
    }
}

主なタグ

タグ	説明
@param	メソッドの引数について説明を書く
@return	戻り値について説明を書く
@throws	throwsに記述している例外について説明を書く
@deprecated	非推奨であることを示す
{@link パッケージ名.クラス名#メソッド名 代替テキスト}	他のクラスへのリンク
{@inheritDoc}	OverrideしているメソッドのJavaDocを参照する