Javadoc模板生成器

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

任何人都知道一个很好的解决方案？

编辑:

JAutodoc是我一直在寻找的.它有Ant任务,一个Eclipse插件,并使用Velocity进行模板定义.

eclipse 的JAutodoc插件完全符合您的需求,但具有包粒度:

右键单击一个包,选择"为成员添加javadoc ...",然后添加骨架.

有许多有趣的选项:javadoc的模板,在每个文件的标题中添加一个TODO:"模板javadoc,必须填充......"等.

我认为自动生成空Javadoc是一种反模式,应该气馁; 它为代码提供了记录的外观,但只是给代码库增加了噪音.

我建议您配置代码编辑器,以便在实际编写javadoc时使用每个方法和每个类的基础(一个指向Eclipse的功能的评论者执行此操作).

您也可以将光标放在您想要JavaDoc的方法上方的行上,然后键入:

/**

然后按Enter键.这将生成您的JavaDoc存根.