2

我创建了很多异常类，扩展了“异常”并创建了与超类“异常”的构造函数匹配的所有构造函数。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

4

3 回答 3

2

好吧，恐怕使用 Javadoc 并匹配 Sun Checkstyle 规则可能是不可能的。

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

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

于 2013-03-12T22:19:38.197 回答
0

我想你正在寻找这样的东西：

/**
 * {@inheritDoc}
 */

您可以在这里阅读：http: //docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#@inheritDoc

于 2013-03-12T22:15:04.960 回答
0

我的建议是：不要，并考虑在 checkstyle 中至少为那些构造函数禁用该规则。每个人都知道他们在做什么，或者可以很容易地查到这一点。努力提供真正有用的文档。

于 2013-03-12T22:36:41.800 回答