使用（模拟）可选/默认参数为函数编写Javadoc

Question

我有一些用于某些C ++代码的Java包装器，我在其中通过手动重载相关方法来模拟默认参数。 [示例与Does Java support default parameter values?中的相同。]在一种情况下，C ++ fn有3个可选参数，因此我不得不用Java编写8个方法。

现在我想为所述方法编写JavaDocs。有没有办法避免写8次基本相同的文字？除了冗长，这将是一场维护噩梦...

编辑：这是一个玩具示例，说明方法的签名：

void foo(int i, String s, double d);
void foo(int i, String s);
void foo(int i, double d);
void foo(int i);
void foo(String s, double d);
void foo(String s);
void foo(double d);
void foo();

Answer 1

一种解决方案是在包含所有参数的方法中编写完整的Javadoc文档，然后使用@link和/或@see指令链接到重载中的文档，例如：< / p>

/**
 * The parameters in the wrapped C++ method are all  optional,
 * so we had to write an overload for each parameter combination.
 * @param i the int parameter used for x. 
 * @param s the string parameter used for y.
 * @param d the double parameter used for z.
 */
void foo(int i, String s, double d);

/**
 * Overload of the {@link #foo(int, String, double)} method with a default {@code d}.
 */
void foo(int i, String s);

/**
 * @see #foo(int, String, double)
 */
void foo(int i, double d);

...