CheckStyle - 用于覆盖方法的 JavaDoc答案

【问题标题】：CheckStyle - JavaDoc for overrided methodsCheckStyle - 用于覆盖方法的 JavaDoc
【发布时间】：2011-08-22 13:19:42
【问题描述】：

对于被覆盖的方法，Eclipse 会像这样生成 javadoc：

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

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

【问题讨论】：

【解决方案1】：

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

【讨论】：

【解决方案2】：

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

/** {@inheritDoc} */

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

【讨论】：