javadoc:@version和@since

时间:2009-02-23 16:49:16

标签: java documentation javadoc

是否有理由同时将@version@since作为课程的一部分?

他们似乎互相排斥。

此外,%I%%G%是什么意思,以及如何设置/使用它们?

 @version %I%, %G% 

由于

3 个答案:

答案 0 :(得分:64)

@version标记应该是相关版本或文件的当前版本。 %I%%G%语法是源控件软件将替换为文件的当前版本以及文件签出日期的宏。

@since标签应该用于定义您添加方法,类等的版本。这是您向其他开发人员提示他们只应该在针对特定版本的包运行时期望该方法的提示。如果您将代码作为供其他人使用的库运送,我会考虑文档中这些非常重要的部分。

答案 1 :(得分:8)

我不知道它们是如何相互排斥的。一个用于定义版本,另一个用于描述,因为方法存在时。例如:

/**
 * Does Whatever
 * @version 1.2.3
 * @since 1.2.0
 *
 */
public void myMethod() {
    // .......
}

关于你提到的字符,它们似乎是专有的,无论如何我都不知道它们的意思。

答案 2 :(得分:2)

每次编辑都会记录

@version。[1.3.21]

@since的意思是,因为哪个版本将支持此界面或等等。[1.3] Yuval Adam很有意思,但这不是标准,java doc的目的是每个人都能理解的。