Javadoc 模板生成器 [英] Javadoc template generator

问题描述

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

I have a large codebase without Javadoc, and I want to run a program to write a skeleton with the basic Javadoc information (e.g., for each method's parameter write @param...), so I just have to fill the gaps left.

有谁知道解决这个问题的好方法吗?

Anyone know a good solution for this?

JAutodoc 正是我想要的.它有 Ant 任务、一个 Eclipse 插件，并使用 Velocity 作为模板定义.

JAutodoc is what I was looking for. It has Ant tasks, an Eclipse plugin, and uses Velocity for the template definition.

推荐答案

Eclipse 的 JAutodoc 插件完全适用您需要什么，但具有包粒度:

The JAutodoc plugin for eclipse does exactly what you need, but with a package granularity :

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

right click on a package, select "Add javadoc for members..." and the skeleton will be added.

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

There are numerous interesting options : templates for javadoc, adding a TODO in the header of every file saying : "template javadoc, must be filled...", etc.

这篇关于Javadoc 模板生成器的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！