CheckStyle - 用于覆盖方法的JavaDoc

Question

对于重写方法，Eclipse生成如下所示的javadoc：

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

实际上，它不是javadoc评论，但它可以正常工作。 Checkstyle将此评论标记为警告。如何调整checkstyle以禁用此警告？

Answer 1

如果我记得没错，你应该只使用@Override注释，而不是编写/生成任何文档。这应该避免checkstyle警告，但仍会生成指向父JavaDoc的JavaDoc（指定者：）。

Answer 2

对于较旧的Java版本（1.6之前）：
@Override注释仅适用于超类的继承方法 所以最好使用

/** {@inheritDoc} */

也适用于实现接口的方法 Checkstyle将此注释识别为JavaDoc，并且您只有一个地方可以描述您的方法。