可以将javadoc参数descr绑定到super方法的javadoc吗?

时间:2014-05-02 11:40:14

标签: java javadoc

有些情况下我在基类中使用了一些具有一般用法的方法(例如数据库CRUD方法),然后我更好地在受控制中对其进行排序,从而扩展该基类。

有时,我需要在控制器中为方法编写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...
}

因此,有没有一种方法可以将原始描述与此参数的javadoc绑定,而不是粘贴param3的描述。这样,它不仅会更快,而且如果在超级方法中更新过,我也不必更改说明。

1 个答案:

答案 0 :(得分:2)

在某些情况下,您可以继承javadoc:

/** 
 * {@inheritDoc}
 */

Eclipse和Co仍然应该找到javadoc。

但是:我认为参数的清晰名称可以避免这个问题。