Javadoc模板生成器

Question

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

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

修改

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

Answer 1

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

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

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

Answer 2

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

我建议您配置代码编辑器，以便在实际编写javadoc时使用每个方法和每个类的帮助（一个评论者指向Eclipse的功能，这样做）。

Answer 3

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

/**

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

Answer 4

您可以配置eclipse以显示缺少javadoc的事件的警告，或者让javadoc没有所有信息，或者信息错误。它还可以插入模板供您填写。

不是你要求的工具，但可能更好，因为你不会在你错过的方法上得到空的骨架。

您可以通过调查和编辑路径窗口＆gt;之外的首选项页面来实现此目的。偏好＆gt; Java＆gt;编译器＆gt; Javadoc为您的工作区。该首选项页面的屏幕截图如下：

有关此屏幕中项目的更多信息，请点击以下链接：

Java Compiler Javadoc Preferences Help

Answer 5

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

实施例

/**
     * @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;
    }

Answer 6

如果右键单击Eclipse中的文件源，它在源菜单下有一个Javadoc生成选项。