在编写文档时,在Java类末尾添加版权?

时间:2015-09-21 07:11:05

标签: java javadoc

我正在为我的java文件编写文档。在该文档中,我想在每个生成的文件的末尾添加一些html链接。为此,在编写java文档时我必须使用什么?

2 个答案:

答案 0 :(得分:0)

如果您使用Eclipse作为IDE,则可以使用插件JAutodoc: http://jautodoc.sourceforge.net/

在每个文本文件的前缀处添加默认文本。

答案 1 :(得分:0)

根据javadoc manual(目前找不到更新版本),您应该在从CLI生成Java API文档时使用-footer,例如:

javadoc -footer "<b>Copyright 2015 Lakshmi Prasanna</b><br>" com.mypackage

以下是类似的example,但使用的是-header

现在,如果你使用一个好的IDE,它至少应该允许你在项目设置中的某个地方输入。当时Eclipse不是很灵活,所以我不得不制作一个Ant脚本(哎呀)。

编辑:

此方法的一个限制是CLI -option依赖于该工具。这适用于标准javadoc命令,但可能不适用于其他供应商的doclet。但是我不确定是否有通用的方式来实现OP的要求。

无论如何,它似乎是:不是-footer而是-bottom