CheckStyle - JavaDoc для переопределенных методов

Question

Для переопределенных методов Eclipse генерирует javadoc следующим образом:

/* (non-Javadoc)
 * @see com.ncube.qtpokertest.listeners.PlayerChangeListener#
 * nameChanged(com.ncube.qtpokertest.events.PlayerChangeEvent)
 */

на самом деле это не комментарий javadoc, но он работает правильно. Checkstyle пометить этот комментарий как предупреждение. Как настроить checkstyle, чтобы отключить это предупреждение?

Answer 1

Для более старых версий Java (до 1.6):Аннотация @Override работает только для унаследованных методов суперклассов.Так что лучше использовать

/** {@inheritDoc} */

, который работает также для методов, реализующих интерфейсы.Checkstyle распознает этот комментарий как JavaDoc, и у вас есть только одно место, где вы описываете свой метод.

Answer 2

Если я правильно помню, вы должны просто использовать аннотацию @Override и вообще не писать / генерировать какую-либо документацию. Это должно избегать предупреждения о контрольном стиле, но, тем не менее, генерировать JavaDoc, который указывает на родительский JavaDoc (Указанный:).