如何在JavaDoc中插入创建日期

时间:2015-03-31 23:47:49

标签: java formatting format javadoc

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

在作者标签下方,字符串"在"

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

在作者标签下方,字符串为"日期:"

/**
 * 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
...

1 个答案:

答案 0 :(得分:5)

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

例如,here是eclipse的文档,this页面显示了可以在模板中使用的变量。