Javadoc 重用预定义文本

Question

是否有可能以某种方式创建如下内容:

/** #define COMMON_NOTE_1="This note I want to re-use in several places" */
int varA; /** variable A (COMMON_NOTE_1) */
int varB; /** variable B (COMMON_NOTE_1) */

一些 suggested 3 years ago it may not been possible你知道这在现代是否可能吗？

如果仍然不行，有人建议使用 C 预处理器。知道 C 预处理器是否可以与 IntelliJ 集成吗？或者我也很高兴在编译前自动执行 python 脚本。我知道 Intelli J 可以配置为在编译前运行 Ant。如果现成的解决方案，我也会接受。但我不想自己编写/修改 ant 脚本。

Answer 1

所以我确实找到了一种丑陋且有限的方式。但无论如何，到目前为止最好的事情。比以前提出的 DUMMY 变量好多了。 DUMMY 变量的主要丑陋之处在于您的类和文档中会有 DUMMY 变量。甚至当您在代码中吞下杂乱的 DUMMY 变量时，您也不会直接看到“Note”，而只会看到它的链接。

更好的方法是使用标签 @value .首先创建丑陋的类，如 DocCommon，其中将隐藏所有注释。例如:

public class DocCommon {
    public static final String note1 = "Note: This is common note";
    public static final String note2 = "Note: This is common note2";
}

你从任何地方链接它，比如:

/** A: {@value com.whoever.DocCommon#note1} B*/

然后它将直接显示在文档中，如下所示:

A: "Note: This is common note" B

缺点是会用引号""显示。另一个缺点是它不接受任何 HTML 标签。例如。当你把 <br>它会在 javadoc 编译期间抛出错误。所以这行不通:

public static final String note1 = "Note: <br> This is common note";

谁有更好的建议？我注意到除了 Javadoc 之外，可能还有其他文档工具。关于支持多行#defines 的特定提示有什么提示吗？