java - 关于 checkstyle SUN 约定的派生异常的最简单的 javadoc 文档？

Question

我创建了很多异常类，扩展“Exception”并创建与父类(super class)“Exception”的构造函数匹配的所有构造函数。 Eclipse 生成以下内容:

/**
 * 
 */
package pone.interfaces;


/**
 * @author wnck
 *
 */
public class FancyException extends Exception {

/**
 * 
 */
public FancyException() {
    // TODO Auto-generated constructor stub
}

/**
 * @param message
 */
public FancyException(String message) {
    super(message);
    // TODO Auto-generated constructor stub
}

/**
 * @param cause
 */
public FancyException(Throwable cause) {
    super(cause);
    // TODO Auto-generated constructor stub
}

/**
 * @param message
 * @param cause
 */
public FancyException(String message, Throwable cause) {
    super(message, cause);
    // TODO Auto-generated constructor stub
}

/**
 * @param message
 * @param cause
 * @param enableSuppression
 * @param writableStackTrace
 */
public FancyException(String message, Throwable cause,
        boolean enableSuppression, boolean writableStackTrace) {
    super(message, cause, enableSuppression, writableStackTrace);
    // TODO Auto-generated constructor stub
}
}

我不想记录所有参数标记，因为构造函数只是在语义上匹配基类的构造函数。

如何使用 javadoc 并匹配 SUN checkstyle 规则以快速、干净且简单的方式记录这一事实？

问候wnck

Answer 1

嗯，恐怕无法使用 Javadoc 并匹配 Sun Checkstyle 规则。

这是因为@inheritDoc Javadoc 标记不能可靠地与构造函数一起使用(它们不可继承)。此外，Checkstyle 无法识别构造函数上的 @inheritDoc。相反，最好的选择是使用 Checkstyle 配置从 JavadocMethod 要求中排除异常类的构造函数。

后者可以通过设置 JavadocMethod 的 tokens 属性来实现。 仅检查METHOD_DEF并省略CTOR_DEF。对于异常类，简单地 suppress 也可能有意义。 JavadocMethod 完全检查，因为异常可能不包含任何真正需要解释的方法。