在Javadoc中重用Javadoc?

时间:2017-09-03 16:59:26

标签: java javadoc

我刚学会了,现在正在尝试实现javadoc。

有没有办法重新使用已编写的javadoc ,例如,当您重载方法以获取更多参数时?

我问,因为我完成了这个:我写了一个方法,它采用了7个参数:

/** 
 * @param a    explanation a
 * @param b    explanation b
 * @param c    explanation c
 * @param d    explanation d
 * @param e    explanation e
 * @param f    explanation f
 * @param g    explanation g
 */
public void myMethod(int a, int b, int c, int d, int e, int f, int g)
{
    //Whatever
}

然后我添加并重载了接受所有相同参数的版本,再加上3个(总共10个参数)。

/** 
 * @param a    explanation a
 * @param b    explanation b
 * @param c    explanation c
 * @param d    explanation d
 * @param e    explanation e
 * @param f    explanation f
 * @param g    explanation g
 * @param h    explanation h
 * @param i    explanation i
 * @param j    explanation j
 */
public void myMethod(int a, int b, int c, int d, int e, int f, int g, int h, int i, int j)
{
    //Whatever
}

我从7参数版本中复制并粘贴了现有的javadoc,用于重载的10参数版本,并对其进行了详细说明。

它占用了大量的空间,我不禁觉得自己错过了一些东西。

我查看了Oracle documentation,但如果它在那里,我还没有发现它。

我知道有一些方法可以使用诸如{@code someparam}之类的技术在javadoc中引用变量,所以我认为可以有一种方法可以做到这一点。

在我的脑海中,我有一个类似的愿景:

/** 
 * {@docstring theOtherVersionOfThisMethod}
 * @param h    explanation h
 * @param i    explanation i
 * @param j    explanation j
 */
public void myMethod(int a, int b, int c, int d, int e, int f, int g, int h, int i, int j)
{
    //Whatever
}

0 个答案:

没有答案