关于java：Javadoc模板生成器

Javadoc template generator

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

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

编辑：

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

eclipse的JAutodoc插件完全可以满足您的需求，但具有软件包粒度：

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

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

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

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

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

/**

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

选择要添加Javadoc和alt + Shift + j的方法，自动创建Javadoc注释。

例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

/**
* @param currDate
* @param index
* @return
*/
public static String getAtoBinary(String currDate, int index){
String HourA ="0";
try{
String[] mydate = currDate.split("/");
HourA = mydate[index].substring(1, 2);
}catch(Exception e){
Log.e(TAG, e.getMessage());
}
return HourA;
}

您可以将eclipse配置为对缺少javadoc或缺少所有信息或错误信息的javadoc的事物显示警告。它还可以插入模板供您填写。

并不是您所需要的工具，但可能更好，因为您最终不会在错过的方法上留下空白的骨架。

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

The so-called Javadoc preference page