Eclipse 的 JavaDoc 插件?

声明:本页面是StackOverFlow热门问题的中英对照翻译,遵循CC BY-SA 4.0协议,如果您需要使用它,必须同样遵循CC BY-SA许可,注明原文地址和作者信息,同时你必须将它归于原作者(不是我):StackOverFlow 原文地址: http://stackoverflow.com/questions/1576430/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me): StackOverFlow

提示:将鼠标放在中文语句上可以显示对应的英文。显示中英文
时间:2020-09-19 14:04:16  来源:igfitidea点击:

JavaDoc plugin for eclipse?

eclipseeclipse-pluginjavadoc

提问by mark smith

I was looking for a javadoc plugin for eclipse so that I can document for methods etc. I know in eclipse you can do ALT+ SHIFT+ Jbut I was wondering if there was a more powerful plugin.

我正在为 eclipse 寻找一个 javadoc 插件,以便我可以记录方法等。我知道在 eclipse 中你可以做ALT+ SHIFT+J但我想知道是否有更强大的插件。

I use GhostDoc in VS 2008 which basically when you say document it enters all the parameters and return values and even starts the paragraph for you.

我在 VS 2008 中使用 GhostDoc,基本上当你说文档时,它会输入所有参数和返回值,甚至为你开始段落。

I was hoping for something like that in eclipse because with ALT+ SHIFT+ Jthe only this it does is install the

我希望在Eclipse中类似的东西,因为有ALT+ SHIFT+J的只有这确实是安装

     / ***** /* lines

Any help really appreciated

任何帮助真的很感激

GhostDocisn't available for eclipse, its c# only, I use - its great.
Does something exist similar for eclipse?

GhostDoc不适用于 Eclipse,它仅适用于 c#,我使用 - 它很棒。
日食是否存在类似的东西?

采纳答案by Trick

http://jautodoc.sourceforge.net/- Maybe this will satisfy you.

http://jautodoc.sourceforge.net/- 也许这会让你满意。

回答by Daff

If you are on your method declaration with the cursor and press ALT + SHIFT + J (or right click on the method you want to document in the outline, then Source -> Generate Element Comment) Eclipse will insert all the @param and @return tags accordingly and sets the cursor to the comment.

如果您使用光标在方法声明上并按 ALT + SHIFT + J(或右键单击要在大纲中记录的方法,然后源 -> 生成元素注释)Eclipse 将插入所有 @param 和 @return相应地标记并将光标设置为注释。

Another nice feature is that you can press CTRL + Space in the JavaDoc comment to create links to other classes.

另一个不错的功能是您可以在 JavaDoc 注释中按 CTRL + 空格键来创建到其他类的链接。

回答by Taras

This is not for Eclipse but also may be useful. I have used JavaDoc utility to generate HTML documentation for project:

这不适用于 Eclipse 但也可能有用。我已经使用 JavaDoc 实用程序为项目生成 HTML 文档:

javadoc -sourcepath "ROOT\src" com.package.name1 com.package.name2 com.package.nameN -d "javadoc_output_dir"