【问题标题】:Javadoc versioningJavadoc 版本控制
【发布时间】:2023-12-30 02:31:01
【问题描述】:

我的项目中的版本编号有点问题。

例如说我有 4 个班级 一 二 三 四个

我第一次发布这个软件时,它会被标记为版本 1.0.0

在我的 java doc 注释中,对于所有类,我将其作为 @版本 1.0.0

所以现在测试将它发送回来,并带有第二类中的错误

我更新了第二类,现在必须发布版本 1.0.1

我现在是否更新每个类中的@version 标签?

还是我最终会在 javadoc cmets 中得到一堆具有不同版本号的类?

【问题讨论】:

    标签: version javadoc


    【解决方案1】:

    我认为错误修复根本不会影响这一点,因为在修复错误时,您只需更改版本号中的修订号(第 3 个)。而且您不必在您的 javadoc 中添加修订号 - 它在那里没有用,因为 javadoc 用于描述 API,并且 API 不会随着修复错误而改变。

    这意味着您应该只输入 @version 1.2 而不是 @version 1.2.6

    您的 javadoc 仅在您更改 API 时才会更改 - 而不是您必须更改主要(第一个)或次要(第二个)版本号,并且应该在您的 javadoc 中投影。

    我认为您应该只更改已更改类中的版本号,因为其他类是从以前的版本“继承”的,因此未更改类中的版本号应该保持不变。但我不确定..

    【讨论】:

      【解决方案2】:

      我相信正确的答案只是更改受该错误影响的那些文件。

      我会将版本或修订留给您的控制版本。在理想情况下,脚本会保持版本同步。

      当然,这个问题是主观的。如果您打算将版本标签用作营销工具,那么是的,您可能希望所有代码都使用相同的版本。

      【讨论】: