以下のような 3 つのコンストラクターを持つクラスがあるとします。
public class ExampleClass {
// constructor #1
public ExampleClass(int a) {
this(a, "aaa"); // "aaa" is just an arbitrary default for b
}
// constructor #2
public ExampleClass(String b) {
this(2, b); // 2 is just an arbitrary default for a
}
// constructor #3
public ExampleClass(int a, String b) {
// a has an arbitrary minimum value of 3
// b has an arbitrary minimum length of 3
if (a < 2 || b.length() < 2) {
throw new IllegalArgumentException("a and b cannot be less than 2");
}
// ...
}
}
この場合、3 つのコンストラクターがあります。3 番目はプライマリ コンストラクターのようなもので、他のコンストラクターは単純にデフォルトを提供するため、両方ではなく 1 つの値のみを指定してクラスを構築できます。JavaDoc を介してそのようなクラスのドキュメントを作成しようとしています。最初または 2 番目のコンストラクターのドキュメントを作成する場合@throws
、可能性をドキュメント化するためにタグを使用しIllegalArgumentException
ますか? IllegalArgumentException
それとも、3 番目のコンストラクターのドキュメントのみのドキュメントを保存する必要がありますか? a
その場合、2文字を超えなければならない、または2文字を超えなければならないことを表現する最も適切な方法はb
何ですか? IllegalArgumentException
で文書化せずに がスローされる可能性があるとどのように述べればよいでしょう@throws
か?