字符串的 Javadoc 常量字段值

Question

我不喜欢 Javadoc“常量字段值”页面列出字符串常量的方式。

示例:

public static final String REGEXP_PATTERN = "^\\s*$";

在 Javadoc 页面上，该常量将以 ^\\s*$ 值列出，我认为这是完全错误的，它应该是 ^\s*$。

javac 需要转义 \ 的事实是无关紧要的。该字段的值 - 如果你问我的话 - 是^\s*$，这就是Javadoc应该列出的内容。

有什么办法可以实现这个目标吗？

当前的问题是，无论您相信与否，我们的 Javadoc 文档也被非 Java 人员使用。对于非 Java 人来说这是没有意义的。

Answer 1

Is there are way I can achieve this?

您需要通过对默认 doclet 进行子类化来创建自己的 doclet，简要浏览一下 relevant source code建议您只需要提供您自己的 ConstantsSummaryWriterImpl 子类，其 getValue(FieldDoc)方法被重写以使用 member.constantValue() 代替 member.constantValueExpression()。

要将此编写器连接到适当的位置，您还需要对 HtmlDoclet 进行子类化并重写 configuration() 以返回您自己的 ConfigurationImpl 子类，后者又返回您自己的 WriterFactoryImpl 子类，而 WriterFactoryImpl 又返回您的自定义常量编写器，最后使用 javadoc 的 -doclet 选项来告诉它使用您的自定义 do clet 而不是标准的。