将“上次修改时间”时间戳插入 javadoc 页脚答案

【问题标题】：Insert "Last Modified" timestamp into javadoc footer将“上次修改时间”时间戳插入 javadoc 页脚
【发布时间】：2011-06-20 21:33:28
【问题描述】：

有没有办法指定类文件的最后修改日期？我希望每个 javadoc 页面都包含类文件的最后修改时间戳，最好在页脚中。

我以为我前段时间做过类似的事情，但在网上找不到任何示例，并且页脚的文档只是表明它可以包含 html。那么生成javadoc时可以不设置任何占位符吗？

谢谢。

【问题讨论】：

标签： javadoc footer last-modified

【解决方案1】：

某些源代码控制系统允许您编写在提交文件时更新的标记。如果你把它放在 javadoc 中，javadoc 会告诉你修订号和上次提交的时间。

【讨论】：

【解决方案2】：

我认为 javadoc 中没有此功能。您为什么不依靠源代码管理来为您完成这项工作？如果是 SVN，您可以定义在提交时自动填充的关键字（请参阅svn propset）。这样好多了，您无需担心 javadoc 处理。

如果更简单的方法可以满足，您可以在底部选项中添加一个脚本，例如：

-bottom "<font size=\"-1\">Created by `echo $USER`, at `date +%Y-%m-%d\ %H:%M:%S.%N`.</font>"

【讨论】：

请注意，这个例子使用的是Unix/Bash，但是你可以很容易地适应Windows/DOS。
这将放置javadoc生成的最后日期，而不是每个类的最后修改日期。
所以你依赖一个 SVN 建议来为你做这件事...... javadoc 选项中的任何命令都不允许你动态放置每个正在处理的文件的日期，它只是变成一个静态字符串（或我们可以为此使用命令stat）。

【解决方案3】：

我认为将时间戳写入代码是编辑器的工作。 Emacs 就是这样做的：

package my.tuple;

/**
 * Implementation of an ordered 2-tuple.
 *
 * @date 2013-07-03
 */

public class Pair<A,B>
{
}

// Local Variables:
// time-stamp-pattern: "0/^ \\* @date %:y-%02m-%02d$"
// End:

之后文档处理器可以读取日期。但是标准的 javadoc 不知道日期。为此，您需要 Eclipse 或 Doxygen。

【讨论】：