Checkstyle "Ожидаемый тег @param для 'id'" ошибка - PullRequest
Новая
       6

Checkstyle "Ожидаемый тег @param для 'id'" ошибка

6 голосов
/ 24 февраля 2012

Я использую контрольный стиль в своей кодовой базе, http://checkstyle.sourceforge.net/,, и у меня возник вопрос относительно JAVADOC.

У меня есть такие статические функции: 

 **
 * @param id
 */
public static void getName(final String id) {
 }

, когда checkstyle жалуется на

Ожидаемый тег @param для 'id'

Когда я даю описание как 

@param id id

тогда все работает нормально, но я не хочу давать описание для каждого параметра и возвращать. Есть ли альтернатива, чтобы это исправить?

Ответы [ 3 ]

13 голосов
/ 24 февраля 2012

Вы правы - это предупреждение означает, что у вас нет описания параметра.Если вы не хотите описывать параметр, зачем его упоминать?Ваш текущий JavaDoc бессмысленен и занимает только бесценное пространство редактора.

Либо полностью удалите параметр из JavaDoc (я полагаю, его смысл очевиден из контекста), либо документируйте его правильно.И 

/**
 * id The id
 */

не является надлежащей документацией.

3 голосов
/ 24 февраля 2012

Зачем запускать checkstyle, если вы собираетесь его игнорировать?

Я в основном согласен с ответом @Tomasz Nurkiewicz, за исключением того, что я определенно задокументирую его.

Значение final String id может быть очевидным. К тебе . Для сейчас . Метод getName также может быть очевиден - пока.

Когда я смотрю на него, я понятия не имею, что он делает или какой «идентификатор» мне нужно передать. Получает ли он полное официальное имя пользователя? Какое имя они ввели? Их [фамилия, имя]? Какой тип id String мне нужно передать? Внутренний идентификационный номер / код приложения? У вас нет javadoc для того, что делает сам метод. 

/**
 * Gets the indicated user's full name as entered when they registered.
 * @param id The application internal id generated when the user registered.
 * @return "void" ???  How do you get a name if it returns VOID?
 */
public static void getName(final String id) {
    ...
}

Я бы объявил это как public static String getName(...) потому что как вы можете получить имя, если оно ничего не возвращает? Если он делает что-то еще, например, поместите имя куда-нибудь, вы можете получить его позже, тогда (1) это не должно называться «getName», и (2) вам определенно необходимо документировать этот факт в вашем javadoc.

0 голосов
/ 05 августа 2015

Вы можете исправить это, изменив свой комментарий 

/**
* this is comment of function 
* @param id **this is id of table**
* @param username **this is name of user need for login**
*/

Пожалуйста, сосредоточьтесь на ** {текст} **, чтобы исправить эту ошибку. Спасибо

...