0

Javaのメソッドドキュメントの正しいドキュメントですか？コードの私の部分は以下のとおりです。パラメータはありませんが、戻り値があります。ローカル変数のみ。

/**
 *This method prompts user to enter the how many numbers user is going to test.
 *
 *@return     The validated value based on parameter.
 */

public static int getNum()
{
    int t;
    Scanner input=new Scanner(System.in);

    System.out.print("How many numbers would you like to test? ");
    t=input.nextInt();

    while (validateNum(t))
    {
        System.out.print("How many numbers would you like to test? ");
        t=input.nextInt();
    }

    return t;
}
4

1 に答える 1

0

メソッドのJavadocは、「このメソッド」という単語で開始するべきではありません。これは、すべてのメソッドの説明の先頭に含まれています。

同様に、クラスを文書化する場合、コメントの前に「このクラス」という単語が表示されると想定します。

また、実装について説明している（ユーザーに尋ねる）が、実装は、ファイルから読み取る、定数を返すなど、任意の方法で自由に取得できる必要があります。

より適切なものは次のとおりです。

/**
 * Return how many numbers user is going to test.
 *
 * @return The number of numbers to be tested
 */
于 2012-11-16T04:35:37.930 に答える