多个方法/常量的一个 javadoc 描述答案

【问题标题】：One javadoc description for mutiple methods/constants多个方法/常量的一个 javadoc 描述
【发布时间】：2018-12-19 15:11:15
【问题描述】：

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

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

...

我想要这样，因为它可以让我的代码更整洁。

【问题讨论】：

你可以使用{@link package.class#member label}
您不能将一个 JavaDoc 注释应用于多行。它不会正确生成 JavaDoc。但是由于您有两个变量，因此必须出于两个不同的原因使用它们。我不确定一个单一的描述是否会很好。
@Ascalonian 它们具有相同的范围（如属性）。在描述中我只写范围，因为可以看到它们的价值，这也描述了使用或不使用的原因。我可以同时使用一个或多个。

标签： java javadoc

【解决方案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}

【讨论】：

这对我来说并不理想。我的理想是出现直接的描述。但最终它帮助了我。谢谢。
我认为这不可能！很高兴有帮助！ :)
我也是这么想的
我找到了另一种解决方案，但这会使他们的路径更长一些。创建一个带有描述的内部类，并在该类中包含所有常量。