【发布时间】:2015-03-31 23:47:48
【问题描述】:
在 JavaDoc 中插入类创建日期的最佳方法是什么?一些例子:
在作者标签下方,带有字符串“created on”
/**
* 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
...
【问题讨论】:
-
您要创建日期还是创建数据?
-
这真的是一个见仁见智的问题(并且可能会因此关闭),不要纠结于如何显示日期以供评论。
-
我对日期格式的投票将是任何程序员都可以清楚地阅读的日期格式,无论国家、文化或时区差异如何。喜欢RFC 3339。 (和机器可读的同一套“不管”)
-
只要有recommended way通过
@version标签表示日期,我认为这个问题被错误地关闭了。是的,OP 的问题似乎没有得到回答。 -
在 Eclipse 窗口中使用 -> 首选项 -> Java -> 代码样式 -> 代码模板 => 注释 -> 类型 -> 点击编辑按钮粘贴
@Date ${d:date('E dd-MMM-yyyy HH:mm')}这将生成@Date Mon 13-Jan-2020 21:10当你使用类级别的 Javadoc
标签: java formatting format javadoc