Javadoc模板生成器[关闭]

StackOverflow https://stackoverflow.com/questions/29689

  •  09-06-2019
  •  | 
  •  

题

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

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

编辑：

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

有帮助吗？

解决方案

这 自动化文档 Eclipse 插件完全可以满足您的需求，但具有包粒度：

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

有许多有趣的选择：javadoc 的模板，在每个文件的标头中添加 TODO 内容：“模板javadoc，必须填写...”等。

其他提示

我认为自动生成空 Javadoc 是一种反模式，应该劝阻；它使代码看起来像是有文档记录的，但只会给代码库增加噪音。

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

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

/**

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

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

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

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

The so-called Javadoc preference page

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

Java 编译器 Javadoc 首选项帮助

选择方法 您想要添加 Javadoc 和 替代+转移+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;
    }

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

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top