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

Question

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

我有一个 class 有一堆方法，它们都抛出几乎相同的异常；示例：

/**
 * 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 class 跨多个方法传播公共文档注释。但是，这会使您的 javadoc 依赖于您自定义的 javadoc 设置。此外，通过查看源代码来研究您的 API 的人可能会忽略一种方法的注释适用于其他方法。

简而言之，这是个坏主意。您最好剪切并粘贴 javadoc 注释的相关部分……IMO。

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

How to document javadoc exception cause for multiple methods

java

documentation

javadoc