Checkstyle - 在界面中仅检查方法

时间:2012-11-07 14:01:37

标签: checkstyle

是否可以仅对接口中的方法应用JavadocMethod检查程序? (不在实施类中)

2 个答案:

答案 0 :(得分:3)

我们还计划实施它,密切注意issue,不确定何时修复它,或者欢迎提供补丁我们已经拥有完整的开发基础设施。

答案 1 :(得分:1)

如果您使用的是Java 6,则可以使用@Override注释实现方法,这将告诉JavadocMethod检查器不要求Javadoc注释。引用JavadocMethod文档:

  

使用@Override注释标记的方法不需要Javadoc。

文档继续说明你需要Java 6.在Java 5中,你仍然可以使用{@inheritdoc},这比什么都没有好:

  

但是,在Java 5下,无法标记接口所需的方法(这在Java 6下已经更正)。因此,Checkstyle支持使用使用单个{@inheritDoc}标记而不是所有其他标记的约定。

内置的Eclipse代码格式化程序可以自动为您添加@Override注释,因此这应该是您所需要的。