如何在 JavaDoc 中插入创建日期

Question

在 JavaDoc 中插入 class 创建日期的最佳方法是什么？一些例子：

在带有字符串 "created on"

的作者标签下方

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

作者标签下方带有字符串 "Date:"

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

带有不存在的@date 标签

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

其他...

最后，最好的日期格式是什么？

April 1, 2015
2015/04/01
...

Answer 1

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

例如，here is the documentation for eclipse and this页面显示了可以在模板中使用的变量。

How to insert creation date in JavaDoc