如何爲多種方法記錄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; 
} 

我想避免copypasting @throws事物的文檔。

有沒有辦法做到這一點？

Answer 1

使用標準javadoc工具和標準標籤無法做到這一點。

理論上可以定義自定義javadoc標籤和自定義Doclet類，該類可以通過多種方法傳播公共文檔註釋。但是，這會讓您的javadoc依賴於您的自定義javadoc設置。此外，通過查看源代碼來研究您的API的人可能會錯過一種方法的評論適用於其他方法。

總之，它是一個壞主意。你最好剪掉和粘貼javadoc評論的相關部分......海事組織。