2011-06-20 202 views
3

是否有方法指定类文件的最后修改日期?我希望每个javadoc页面都包含最后修改的类文件的时间戳,最好在页脚中。将“上次修改时间”时间戳插入javadoc页脚

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

谢谢。

回答

1

某些源代码管理系统允许您编写一个标记,当您提交该文件时该标记已更新。如果你把它放在javadoc中,javadoc会告诉你修订版本号和它上次提交的时间。

0

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

如果一个简单的方法能满足,你可能只是添加脚本进入底部的选项,如:

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

请注意,此示例使用Unix/Bash,但您可以轻松地适应Windows/DOS。 –

+1

这将会生成javadoc生成的最后日期,而不是每个类的最后修改日期。 –

+0

所以你依靠一个SVN提示来为你做这件事...在javadoc选项中没有命令将允许你动态地放置每个正在处理的文件的日期,它只是成为一个静态字符串(或者我们可以使用命令' stat“)。 –

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。