javadoc - 它是java方法文档的正确文档吗？

Question

它是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;
}

Answer 1

方法的 Javadoc 不应以“此方法”一词开头——这在每个方法描述的开头都隐含。

类似地，在记录课程时，假设“This class”一词出现在您的评论之前。

此外，您正在描述实现（询问用户），但实现应该可以自由地以任何它想要的方式获取它，例如从文件中读取它或返回一个常量。

这里有更合适的：

/**
 * Return how many numbers user is going to test.
 *
 * @return The number of numbers to be tested
 */