2014-05-02 42 views
0

有些情況下,我在基類中使用了一些具有一般用法的方法(例如數據庫CRUD方法),然後我更好地在受控的基類中進行排序。可能將javadoc參數descr綁定到super方法的javadoc?

有時,我需要爲控制器中的方法編寫javadoc,以便我不必跳回超級方法來檢查某些參數的用途。在這種情況下,我打開super方法的javadoc,複製描述並將其粘貼到我的控制器方法中。

現在,爲少量的消息做是好的,但現在我想爲整個項目做評論,這樣的複製/粘貼需要時間。

有沒有一種方法可以自動把原始方法的javadoc參數描述?

例如,

/** 
* A description of the controller method. Blah blah 
* 
* @param param1 My description 
* @param param2 My description 
* @param param3 A description copied from super method 
*/ 
public void controllerMethod(Object param1, Object param2, Object param3) { 
    //method's body... 
} 

所以不是粘貼描述爲param3的,有我結合使用這個參數的Javadoc的原始描述的方法嗎?這樣,它不僅會更快,而且如果在超級方法中更新過,則不必更改說明。

回答

2

你可以在某些情況下繼承的Javadoc:

/** 
* {@inheritDoc} 
*/ 

Eclipse和合作仍然應該找到的Javadoc。

但是:我認爲,參數的明確名稱可以避免這個問題。