Javadoc模板生成器

Question

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

有人知道解决这个问题的好办法吗？

编辑：

JAutodoc是我要找的。它有Ant任务，这是一个Eclipse插件，并使用流速作为模板定义。

Answer 1

eclipse的JAutodoc插件完全可以满足您的需要，但是有一个包粒度：

右键单击包，选择“为成员添加javadoc .”骨架就会被添加进去。

有许多有趣的选项:javadoc模板，在每个文件的头中添加一个TODO，上面写着：“模板javadoc，必须填充.”等等。

Answer 2

我认为自动生成空Javadoc是一种反模式，应该不鼓励；它给代码提供了文档化的外观，但只是增加了代码库的噪音。

相反，我建议您将代码编辑器配置为在实际编写javadoc时在每个方法和每个类的基础上提供帮助(其中一个注释指向Eclipse的特性)。

Answer 3

您还可以将光标放在要JavaDoc的方法上方的行上，然后键入：

/**

然后按回车。这将生成您的JavaDoc存根。