32

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

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

编辑：

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

4

6 回答 6

39

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

右键单击一个包，选择“Add javadoc for members...”，骨架将被添加。

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

于 2008-08-28T10:02:10.887 回答
23

我认为自动生成空 Javadoc 是一种反模式，应该不鼓励。它使代码看起来像是记录在案的，但只是给代码库增加了噪音。

相反，我建议您配置代码编辑器，以便在您实际编写 javadoc 时使用每个方法和每个类来提供帮助（一位评论者指出了 Eclipse 的功能）。

于 2008-09-15T16:35:34.723 回答
13

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

/**

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

于 2013-05-09T22:37:21.600 回答
4

您可以将 eclipse 配置为针对缺少 javadoc 的内容显示警告，或者 javadoc 不包含所有信息，或包含错误信息。它还可以插入模板供您填写。

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

您可以通过调查和编辑工作区路径 Window > Preferences > Java > Compiler > Javadoc 之外的首选项页面来实现此目的。该首选项页面的屏幕截图如下：

所谓的 Javadoc 偏好页面

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

Java 编译器 Javadoc 首选项帮助

于 2008-08-28T10:06:34.870 回答
4

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

例子：

/**
     * @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;
    }
于 2014-08-28T21:32:36.203 回答
2

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

于 2008-08-27T08:05:52.250 回答