Javadoc模板生成器

时间:2020-03-05 18:43:42  来源:igfitidea点击:

我有一个很大的没有Javadoc的代码库,我想运行一个程序来编写带有基本Javadoc信息的框架(例如,对于每个方法的参数,写@param ...),所以我只需要填补空白。

有人知道一个好的解决方案吗?

编辑:

JAutodoc是我一直在寻找的东西。它具有Ant任务,一个Eclipse插件,并使用Velocity作为模板定义。

解决方案

回答

如果在Eclipse中右键单击文件的源,则在源菜单下该文件具有Javadoc生成选项。

回答

eclipse的JAutodoc插件完全可以满足需求,但是具有软件包粒度:

右键单击程序包,选择"为成员添加Javadoc ...",将添加骨架。

有很多有趣的选项:用于javadoc的模板,在每个文件的标题中添加一个TODO,上面写着:" template javadoc,必须填写...",等等。

回答

我们可以将eclipse配置为对缺少javadoc或者Javadoc的信息不完整或者信息错误的事物显示警告。它还可以插入模板供我们填写。

并不是我们所需要的工具,而是更好的工具,因为我们最终不会在错过的方法上留下空白的骨架。

我们可以通过研究和编辑工作空间路径"窗口">"首选项">" Java">"编译器">" Javadoc"之外的首选项页面来实现此目的。该首选项页面的屏幕截图如下:

有关此屏幕中项目的更多信息,请单击下面的链接:

Java编译器Javadoc首选项帮助

回答

我认为自动生成空的Javadoc是一种反模式,因此不建议使用;它使代码看起来像文档一样,但是只会给代码库增加噪音。

相反,我建议我们配置代码编辑器,以便在实际编写Javadoc时使用基于方法和基于类的帮助(一个注释器指向执行此操作的Eclipse功能)。