Как решить At-предложение должно иметь непустое описание? - Checkstyle - Java

Question

Я использую стиль Google Java в плагине checkstyle для затмения Луны. Видя эту ошибку во всем моем Java-документе, но не могу найти, как решить ее. Это незначительно, но это беспокоит меня.

мой javadoc:

/**
   * This is a description of something
   * 
   * @throws Exception
   */

Ошибка в строке @throws, Ошибка:

At-clause should have a non-empty description

Answer 1

Как правило, вы должны написать

 * @throws Exception when this exceptional condition happens

например

 * @throws IllegalArgumentException when num is negative

... и вообще объясняя, почему это исключение произойдет.

Answer 2

Это общее сообщение, отображаемое для всех параметров в документе, начинающихся с '@'. Поэтому для каждого параметра вам нужно добавить описание.

Например:

/**
     * Searches for top cars
     * @param carSearchRequest represents CarSearchRequest body
     * @param userId represents userid
     * @return CarsResponse
     * @throws Exception when userid is null
     */

Answer 3

Чтобы справиться с этим быстро, чтобы моя сборка не выходила из строя из-за проверки стиля, я создал шаблон кода Eclipse для использования в контексте "Javadoc":

${word_selection}
   *           When ${word_selection} occurs.

Выберите имя исключения, нажмите Ctrl + Пробел, выберите "throws" (имя, которое я дал шаблону), и вы получите комментарий, допустимый для Checkstyle:

* @throws IOException
*      When IOException occurs.

Это глупый комментарий, но это тоже глупое требование.