在 javadoc 中自動生成 @version 值

Question

對於 javadoc 中的@version標記，我使用與BuildConfig.VERSION_NAME中相同的值。 我想注入該值，而不是更改每個版本的每個文件。

我試過了：

* @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所建議的那樣

注意：可以覆蓋未來標准標簽的自定義標簽：@configVersion。 為避免潛在的覆蓋，請在自定義標簽名稱中至少使用一個句點字符 (.)。