用於顯示其他方法的文檔的Javadoc標籤

Question

是否有用於顯示其他方法的文檔的javadoc標籤？這些方法只是將調用轉發給其他類的方法。我正在尋找不止於@see。謝謝。

Answer 1

如果您使用{@link MyClass#myMethod(String, etc.)}，工具提示將顯示爲可單擊，單擊時將顯示myMethod的JavaDoc。您還可以在}之前添加說明。

Answer 2

沒有任何機制可以包含任何任意方法的文檔。

但是，您可以繼承在方法評論最近的超類或接口，using the tag {@inheritDoc}聲明同樣的方法文檔，和/或在@param，@return和@throws標籤。

例如：

public class Foo { 
    /** Implements the equals method for Foo objects. 
    * <p>Follows the contract specified by {@link java.lang.Object#equals(Object)}:</p> 
    * 
    * {@inheritDoc} 
    * 
    * @param obj {@inheritDoc} 
    * @return {@inheritDoc} 
    */ 
    public boolean equals(Object obj) { 
    ... 
    } 
    ... 
}