有没有办法让Checkstyle忽略包含@link或@see的javadoc？

Question

我有一些方法可以添加更多类的链接。 例如：

/**
 * Proxy for {@link com.company.Class#someMethod}
 */
public int someMethod(String input) {
   ...
}

目前，当我运行checkstyle时，它抱怨缺少@param和@return。但我不想添加那些。 请注意，此类不会从我要链接的类继承。 @see

也是如此

有没有办法告诉checkstyle查找@link或@see并忽略javadoc项目丢失？

Answer 1

如果你有额外的注释，请阅读http://checkstyle.sourceforge.net/config.html章＆＃34; SuppressWarningsFilter＆＃34;。查看在该页面上抑制checkstyle中违规行为的其他方法。

提出新功能可能是个好主意 - ＆＃34;通过消息抑制＆＃34;这不需要任何代码更新

Answer 2

我无法找到完成此操作的方法，但这就是我所做的：

1. 为方法创建了自定义注释@Proxy：

   @Target(ElementType.METHOD)
   public @interface Proxy {
   }
   

2. 作为另一个方法的代理的每个方法都有一个@link和一个@Proxy注释：

   /**
    * Proxy for {@link com.company.Class#someMethod}
    */
   @Proxy
   public int someMethod(String input) {
       ...
   } 
   

3. 将此注释添加到checkstyle.xml：

   <module name="JavadocMethod">
       <property name="allowedAnnotations" value="Override, Proxy"/>
       ...
   </module>