Javadoc @param @returnの守備範囲について

Question

javadocについて初めて勉強するのですが、以下のコードの場合@paramや@returnはどのように書けばいいんでしょうか？

public class Hello {
public static void main(String[] args) throws IOException {
BufferedReader br = new BufferedReader
(new InputStreamReader(System.in));
String name = br.readLine();
System.out.println("Hello " + name + "!!");
}
}

@paramはメソッドの引数というのは分かるのですが、このような簡単なコードでメインメソッドしか持っていない場合、登場する変数は記述しなくても良いのですか？厳密にjavadocを書かなければいけない場合は、どう書くのが正解なのでしょうか？

よろしくお願い致します。

Answer 1

そもそも、mainメソッドは基本的にプログラム中から呼ぶものではない（args[]には外部プロセスからどんな値でも来てしまう）ものです。JavaDocとして生成することに、大きな意味がある状況ではありません。

ということで、この場合@paramの如何にかかわらず、「どんな値が来ても異常動作にはならないようにしておく」必要があります。@param args[] 外部からの引数とでも書いておけばいいでしょう。

また、返り値はメソッドシグネチャを見れば分かる通りvoidと明らかなので、わざわざJavaDocで明記する必要もないと考えます。

Answer 2

main(String[] args)で引数を使わないのであれば記述する必要はないでしょう。
戻り値もvoidの時は@returnは必要ありません。
ただし、 IOExceptionをスローしているようですので、＠throwsは記述しておいた方がよいでしょう。