用@see寫入正確的javadoc？

Question

如何正確使用@see javadoc？

我的意圖是抽象類與抽象方法。這些方法有javadoc評論。 現在，如果我擴展抽象類，我會覆蓋這些方法並希望使用@see。

但是，對於所有參數，例如return，@see鏈接似乎不起作用。 Eclipse依然抱怨expected @return tag。

那麼我該如何使用它？

public abstract class MyBase { 
    protected abstract void myFunc(); 
} 

class MyImpl extends MyBase { 

    /** 
    * @see MyBase#myFunc() 
    */ 
    @Override 
    protected void myFunc() { .. } 
} 

Answer 1

對於包括從超類文檔的目的，你應該使用{@inheritDoc}不@see。

然後你得到超類的文檔。你可以添加它，如果需要的話，你可以覆蓋像@param和@return這樣的東西。

public abstract class MyBase { 
    /** 
    * @param id The id that will be used for... 
    * @param good ignored by most implementations 
    * @return The string for id 
    */ 
    protected abstract String myFunc(Long id, boolean good); 
} 

class MyImpl extends MyBase { 

    /** 
    * {@inheritDoc} 
    * @param good is used differently by this implementation 
    */ 
    @Override 
    protected String myFunc(Long id, boolean good) { .. } 
}