- это правильная документация по документации метода 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 для методов должны не начала со словами «Этот метод» - который подразумевается в начале каждого описания метода.

Аналогичным образом, при документировании классов предполагается, что перед вашими комментариями появятся слова «Этот класс».

Кроме того, вы описываете реализацию (спрашиваете пользователя), но реализация должна быть бесплатной, чтобы получить ее любым способом, например, прочитать ее из файла или вернуть константу.

Вот что-то более подходящее:

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