java - 多个方法/常量的一个 javadoc 描述

Question

我有这个案例，多个常量具有相同的描述。

/**
 * same description
 */
public static final String a = "...";

/**
 * same description
 */
public static final String b = "...";

/**
 * same description
 */
public static final String c = "...";

...

是否有一种方法可以一次编写描述并多次使用？喜欢:

/**
 * same description
 */
public static final String a = "...";
public static final String b = "...";

...

我想要这个，因为它使我的代码更干净。

Answer 1

我认为最好的方法是使用 @link 将变量相互链接，如下所示

/**
 * Description for all methods
 */
public static final String a = "...";

/**{@link #a readDocHere}*/
public static final String b = "...";
/**{@link #a readDocHere}*/
public static static  String c = "...";

链接语法为{@link package.class#member label}