More than 5 years have passed since last update.

オーバーライドメソッドのjavadoc

Last updated at 2014-05-13Posted at 2014-05-13

public interface A {
	/**
	 * foo する
	 */
	void foo();
}
public class B implements A {
	/**
	 * foo する
	 */
	@override
	public void foo() {
		//
	}
}

オーバーライドしたメソッドに同じことを書いていると、メンテが大変で、ミスのもとです。
これは、下記のように書けます。

public interface A {
	/**
	 * foo する
	 */
	void foo();
}
public class B implements A {
	/**
	 * ${inheritDoc}
	 */
	public void foo() {
		//
	}
}

これで、javadoc コマンドで生成した時に自動的に親クラスの記述が入ります。