如何在JavaDoc中插入创建日期

ᴜsᴇ*_*sᴇʀ 18 java format formatting javadoc

在JavaDoc中插入类的创建日期的最佳方法是什么?一些例子:

在author标签下面,带有字符串"created on"

/**
 * Class description
 *
 * @author Author Name
 * created on 2015/04/01
 */
public class ClassName() {
...
}
Run Code Online (Sandbox Code Playgroud)

在author标签下面,带有字符串"Date:"

/**
 * Class description
 *
 * @author Author Name
 * Date:   2015/04/01
 */
public class ClassName() {
...
}
Run Code Online (Sandbox Code Playgroud)

使用不存在的@date标记

/**
 * Class description
 *
 * @author Author Name
 * @date   2015/04/01
 */
public class ClassName() {
...
}
Run Code Online (Sandbox Code Playgroud)

其他...

最终,最好的日期格式是什么?

April 1, 2015
2015/04/01
...
Run Code Online (Sandbox Code Playgroud)

Bre*_*ken 2

大多数IDE都有一种机制来定义在创建新类时使用的模板.当前日期通常可以作为模板的一部分插入.

例如,这里是eclipse的文档,页面显示了可以在模板中使用的变量.

  • 这根本没有回答OP的问题。他列出了几个选项,其中是说明文件创建日期的理想方式。在 javadoc 标签上方,在下方,使用假 javadoc 标签等。像 OP 和我这样的用户有兴趣知道 JavaDoc 注释中放置文件创建日期的理想位置在哪里。 (8认同)
  • @Hatefiend,考虑使用“@version”标签,如[javase文档](https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@version)的建议。 (4认同)