android - 在 javadoc 中自动生成@version 值

Question

对于 javadoc 中的 @version 标记，我使用与 BuildConfig.VERSION_NAME 中相同的值。我想注入(inject)该值，而不是为每个版本更改每个文件。

我试过:

* @version {@value BuildConfig#VERSION_NAME}

和

* @version @versionName(并添加 -tag versionName:a:"2.2.2")

但这些都不起作用。

我可以在生成文档之前运行 sed，但我更喜欢“官方”支持的东西。

有什么解决办法吗？

Answer 1

对于第二种形式，您可以将自定义标记放在 javadoc 行的开头。

/**
 * This is a class of Foo<br/>
 *
 * @version
 *
 * @configVersion.
 */

然后使用命令javadoc -version -tag configVersion.:a:"2.2.2" 生成你的javadoc，自定义标签应该这样处理。请注意自定义标记名称中的最后一个点 (.) 字符，如命令 javadoc 所建议的

Note: Custom tags that could override future standard tags: @configVersion. To avoid potential overrides, use at least one period character (.) in custom tag names.