Eclipse的GhostDoc等效(Java)

Question

我是GhostDoc在Visual Studio中生成自动注释的忠实粉丝所以我正在寻找一个插件,它在Eclipse中使用我的Java代码完成同样的工作.有什么建议？

Answer 1

你可以查看JAutodoc(http://jautodoc.sourceforge.net/)
来自作者:

JAutodoc是一个Eclipse插件,用于自动将Javadoc和文件头添加到源代码中.它可以选择使用Javadoc和文件头的Velocity模板从元素名称生成初始注释.

这是我发现最接近GhostDoc的那个.

Answer 2

它基本上相当于Javadoc,可以使用快捷方式在eclipse中生成:

ALT+ Shift+J

(当你在Java函数中时,你希望添加javadoc)

从那里,如果你真的想要XML格式,你可以尝试使用JELDoclet

Answer 3

GhostDoc有一个很好的额外功能,通过解析方法名称并将其作为骨架文档提供,可以推断出该方法的功能.例如,在名为GetDocumentName()的方法上使用GhostDoc可能会返回短语"获取文档名称".虽然这不是方法名称提供的信息,但它添加了以前不存在的方法文档.有些人可能认为这几乎没用.我认为相反,因为它支持从源代码生成文档(例如,对于像NDoc或SandCastle这样的工具).

在我看来,GhostDoc对eclipse的"生成元素注释"的最大好处是它鼓励程序员通过添加一种极其快速和可靠的方式来创建它来开始添加文档注释.程序员可以接受推断的文本(适用于50-80%的情况),或者扩展到更复杂的方法.对于不熟悉文档注释使用方式的初级程序员来说,这可以快速缩短学习曲线并鼓励良好的编程实践.