如何为多个方法记录javadoc异常原因

Question

有没有办法指定异常原因的记录方式？

我有一个带有一堆方法的类，它们都抛出几乎相同的异常;例如：

/**
 * some doc
 * @return value
 * @throws SpecificException when X happens
 */
public int fn1() throws SpecificException{
    return 0;
}

/**
 * some different doc
 * @return value
 * @throws SpecificException when X happens
 */
public int fn2() throws SpecificException{
    return 0;
}

我想避免对@throws事情的文档进行复制。

有办法做到这一点吗？

Answer 1

使用标准的javadoc工具和标准标签无法做到这一点。

理论上可以定义自定义javadoc标记和自定义Doclet类，它可以跨多个方法传播通用文档注释。但是，这会使您的javadoc依赖于您自定义的javadoc设置。此外，通过查看源代码来研究API的人可能会错过一种方法的注释适用于其他方法。

简而言之，这是一个坏主意。你最好剪切和粘贴javadoc评论的相关部分...... IMO。