将“Last Modified”时间戳插入javadoc页脚

时间:2011-06-20 21:33:28

标签: javadoc footer last-modified

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

我以为我之前做过这样的事情,但是在网上找不到任何例子,页脚的文档只是表明它可以包含h​​tml。那么生成javadoc时是否可以设置任何类型的占位符?

感谢。

3 个答案:

答案 0 :(得分:1)

某些源代码控制系统允许您对提交文件时更新的标记进行编码。如果你把它放在javadoc中,javadoc会告诉你修订号以及最后一次提交的时间。

答案 1 :(得分:0)

我认为这个功能在javadoc中不可用。你为什么不依靠源代码控制来为你做这项工作?如果是SVN,您可以定义在提交时自动填充的关键字(请参阅svn propset)。这要好得多,您不必担心javadoc处理。

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

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

答案 2 :(得分:0)

我认为编辑器的工作是将时间戳写入代码中。这就是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。