多个方法/常量的一个Javadoc描述

时间:2018-07-11 14:15:29

标签: java javadoc

我有这种情况,对多个常量的描述相同。

/**
 * 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 = "...";

...

我想要这样做,因为它可以使我的代码更整洁。

1 个答案:

答案 0 :(得分:2)

我认为您可以达到的最好效果是使用@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}