Intellij 为方法和类生成 javadoc

发布于 2024-08-13 05:18:22 字数 280 浏览 5 评论 0原文

是否可以设置 Intellij 使用 @author 和 @since date 自动生成方法和类的 javadoc?我在 Eclipse 中有这个功能。

我知道这些文件有模板,而且我还可以手动半自动地将 javadoc 添加到选定的方法/类中。但我希望每个生成的方法/类/枚举/接口/字段等都是自动生成的。

这对于“提取方法”、“覆盖/实现”、“创建 getter/setter”等很有用。这将节省数百个手动操作。

我正在使用 IntelliJ Idea 9.0 BETA 社区版,#IC-90.96。

Is it possible to set up Intellij to generate javadoc for methods and classes, automatically, with @author and @since date? I had this feature in Eclipse.

I know that the files have templates and also I can manually semi-automatically add javadoc to selected method/class. But I want the generation to be automatic for every generated method/class/enum/interface/field etc.

This is useful for e.g. "extract method", "override/implement", "create getter/setter" etc. This would save hundreds of manual actions.

I'm using IntelliJ Idea 9.0 BETA Community Edition, #IC-90.96.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(9

ぺ禁宫浮华殁 2024-08-20 05:18:22

对于 IntelliJ 12:

将插入符号放在方法名称上方,输入 /** 并按 Enter 键让
IntelliJ IDEA 会自动为此方法生成 JavaDoc 存根。
参见此处

For IntelliJ 12:

Position caret above a method name, type /** and press Enter to let
IntelliJ IDEA automatically generate JavaDoc stubs for this method.
See here

丑疤怪 2024-08-20 05:18:22

对于较新版本的 IntelliJ (2018+),您可以使用此解决方案:

在方法签名上方键入 /** + 然后按 Enter 将为您创建 Javadoc 存根。

编辑。 仍然适用于 2023+ 版本。

For newer versions of IntelliJ (2018+), you can use this solution:

Typing /** + then pressing Enter above a method signature will create Javadoc stubs for you.

Edit. Still works on 2023+ versions too.

人生百味 2024-08-20 05:18:22

目前还不可能。您可能想投票给 IDEABKL-1787

It's not possible at the moment. You may want to Vote for IDEABKL-1787.

红玫瑰 2024-08-20 05:18:22

要在 intellij Idea 中生成 javadoc,请转到“工具”->“生成 JavaDoc”(第四个选项),单击它并提供保存文档的路径

for generate javadoc in intellij Idea go to Tools->Generate JavaDoc (4th option) click it and give path to save your Document

白云悠悠 2024-08-20 05:18:22

现在有一个新的插件可用于此。
它工作得很好,你可以用 alt+insert 生成 javadoc。

它称为“javaDoc”,可直接在插件部分中使用。
文档位于:https://github.com/setial/intellij-javadocs/wiki

Now there is a new plugin available for that.
It works great, you can generate javadoc with alt+insert.

It's called "javaDoc", it's available directly in the plugin section.
The documentation is here : https://github.com/setial/intellij-javadocs/wiki

内心荒芜 2024-08-20 05:18:22

我已经放弃了 IntelliJ 能够做到这一点的希望。
我现在在 Eclipse 中打开我的项目,转到所需的文件并调用 JAutoDoc。

I have given up on hoping that IntelliJ will be able to do this.
I now open my project in Eclipse, go to the desired files and invoke JAutoDoc.

烟雨凡馨 2024-08-20 05:18:22

有 JavaDoc 同步插件 8。 http://plugins.intellij.net/plugin/? idea&id=3403
为类中的所有方法生成 javadoc。适用于想法 10。

There is JavaDoc Sync Plugin 8. http://plugins.intellij.net/plugin/?idea&id=3403
Generates javadoc for all methods in class. Works in Idea 10.

泪痕残 2024-08-20 05:18:22

实际上现在可以了,您只需转到“设置/编辑器/文件和代码模板”即可。
在那里,您可以编辑用于创建类、枚举、接口等的模板。
我的 Intellij 版本是 2019.2.3,在 Linux 上。

Actually it's now possible, you can simply go to "Settings/Editor/File and Code Templates".
There, you can edit the template which is used to create classes, enums, interfaces etc.
My Intellij version is 2019.2.3 and on linux.

忆悲凉 2024-08-20 05:18:22

一个简单的选择是访问查找操作菜单(Mac:Cmd+Shift+A | Win:Ctrl+Shift+A)并键入生成 JavaDoc 操作的任意部分。
一旦找到并单击它,就会打开一个用于生成 JavaDocs 的选项菜单,其中包含各种选项和范围。

参考-> https://www.jetbrains.com/help/idea/mastering-键盘快捷键.html

An easy option is to access Find Action menu (Macs: Cmd+Shift+A | Win: Ctrl+Shift+A) and type any part of the Generate JavaDoc action.
Once you found and clicked on that , an option menu for generation of JavaDocs is opened , containing a wide range of options and scopes.

Reference -> https://www.jetbrains.com/help/idea/mastering-keyboard-shortcuts.html

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文