如何在JavaDoc中插入创建日期

Question

在JavaDoc中插入一个类的创建日期，最佳方法是什么？以下是一些示例：

在作者标签下方加上字符串"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
...

- ᴜsᴇʀ

---

你想要创建日期还是数据创建日期？ - Mathemats

这实际上是一个观点问题（并且可能会因此被关闭），不要纠结于评论中日期应该如何显示。 - Mathemats

我的日期格式投票将是一种任何程序员都可以阅读的日期格式，无论国家、文化或时区差异如何，例如RFC 3339。（并且具有相同的“不受影响”的机器可读性） - xmojmr

只要有通过@version标签指示日期的推荐方式，我认为这个问题被错误关闭了。是的，楼主的问题似乎没有得到解答。 - mapto

在Eclipse中使用 Window -> Preferences -> Java -> Code Style -> Code Templates => Comments -> Types -> 点击编辑按钮，粘贴 @Date ${d:date('E dd-MMM-yyyy HH:mm')}，这将在使用类级别Javadoc时生成 @Date Mon 13-Jan-2020 21:10。 - UdayKiran Pulipati

Answer 1

大多数集成开发环境都有定义模板以便在创建新类时使用的机制。当前日期通常可以作为模板的一部分插入。

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

- Brett Okken

---

这完全没有回答原帖作者的问题。他列出了几个选项，问哪种方法最适合用来说明文件创建日期。是在Javadoc标签上方、下方、使用虚假Javadoc标签等。像原帖作者和我这样的用户，想知道在JavaDoc注释中放置文件创建日期的理想位置在哪里。 - Hatefiend

@Hatefiend，考虑使用@version标签，正如javase文档所建议的那样。 - mapto

@mapto 感谢您回答问题，从而证明它被错误关闭了。很遗憾您无法获得任何声望值。 - Noumenon