多个 methods/constants 的一个 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在变量中 @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 语法是 {@link package.class#member label}

多个 methods/constants 的一个 javadoc 描述

One javadoc description for mutiple methods/constants

java

javadoc