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

如何记录多个方法的javadoc异常原因,java,documentation,javadoc,Java,Documentation,Javadoc,是否有办法指定记录异常原因的方式 我有一个类,有一堆方法,它们都抛出几乎相同的异常;例如: /** * some doc * @return value * @throws SpecificException when X happens */ public int fn1() throws SpecificException{ return 0; } /** * some different doc * @return value * @throws SpecificE

是否有办法指定记录异常原因的方式

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

/**
 * 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的文档进行复制粘贴


有办法做到这一点吗?

没有办法使用标准的javadoc工具和标准标记

从理论上讲,可以定义自定义javadoc标记和一个自定义的
Doclet
类,该类跨多个方法传播公共文档注释。然而,这使得javadoc依赖于定制的
javadoc
设置。此外,通过查看源代码来研究API的人可能会忽略一个方法的注释适用于其他方法


简言之,这是个坏主意。您最好剪掉并粘贴javadoc注释的相关部分。。。我同意你的看法。

使用任何过度定制的魔法都是不好的;)