Javadoc 模板生成器 [已关闭]

java documentation javadoc

2022-09-01 09:17:06

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

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

编辑：

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

答案 1

用于 eclipse 的 JAutodoc 插件完全符合您的需求，但具有包粒度：

右键单击一个包，选择“为成员添加javadoc...”并将添加骨架。

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

答案 2

我认为自动生成空Javadoc是一种反模式，应该不鼓励;它给代码带来了被记录的外观，但只是给代码库增加了噪音。

相反，我建议你配置你的代码编辑器，以便在你实际编写javadoc时在每个方法和每个类的基础上使用（一个评论者指出Eclipse的功能可以做到这一点）。