【发布时间】:2012-11-07 14:01:36
【问题描述】:
是否可以仅在接口中的方法上应用 JavadocMethod 检查器? (不在实现类中)
【问题讨论】:
标签: checkstyle
是否可以仅在接口中的方法上应用 JavadocMethod 检查器? (不在实现类中)
【问题讨论】:
标签: checkstyle
我们也计划实施它,请关注issue,不确定何时修复它,或者欢迎提供补丁,我们已经拥有完整的开发基础设施。
【讨论】:
如果您使用的是 Java 6,您可以使用 @Override 注释实现方法,这将告诉 JavadocMethod 检查器不需要 Javadoc 注释。引用 JavadocMethod 文档:
使用
@Override注释标记的方法不需要Javadoc。
文档继续说明您需要 Java 6。在 Java 5 中,您仍然可以使用{@inheritdoc},这总比没有好:
但是,在 Java 5 下,无法标记接口所需的方法(这在 Java 6 下已更正)。因此 Checkstyle 支持使用单个
{@inheritDoc}标签而不是所有其他标签的约定。
内置的 Eclipse 代码格式化程序可以自动为您添加 @Override 注释,所以这应该是您所需要的。
【讨论】: