我有一些方法可以添加指向其他类(class)的链接。 例如:
/**
* Proxy for {@link com.company.Class#someMethod}
*/
public int someMethod(String input) {
...
}
目前,当我用它运行 checkstyle 时,它提示缺少 @param 和 @return。但我不想添加这些。 请注意,该类不是从我要链接的类继承的。 @see 也会发生同样的情况
有没有办法告诉 checkstyle 查找 @link 或 @see 并忽略缺少的 javadoc 项目?
最佳答案
我找不到一种方法来做到这一点,但这就是我所做的:
创建了对方法有效的自定义注释@Proxy:
@Target(ElementType.METHOD) public @interface Proxy { }
作为另一个方法代理的每个方法都有一个 @link 和一个 @Proxy 注释:
/** * Proxy for {@link com.company.Class#someMethod} */ @Proxy public int someMethod(String input) { ... }
将此注释添加到 checkstyle.xml:
<module name="JavadocMethod"> <property name="allowedAnnotations" value="Override, Proxy"/> ... </module>
关于java - 有没有办法让 Checkstyle 忽略包含 @link 或 @see 的 javadoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29154724/