Intellij generate javadoc for methods and classes

Question

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.

score 120 · Answer 1 · edited May 29 '20 at 04:03

120

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

edited May 29 '20 at 04:03

Manu Sharma

656
1
7
22

answered Aug 29 '13 at 09:52

chance

6,307
13
46
70

3

Note: Same for IntelliJ 15 – Andrejs Jul 15 '16 at 07:46
3

New: "Fix doc comment" action to fix Javadoc in case it is already there. – Roland Apr 18 '17 at 09:31
This should be the accepted answer instead of the one from 2009, technologies evolve. – Gherbi Hicham Sep 17 '19 at 09:12
1

Roland's comment is the closest thing to what Eclipse offers, as far as generating a text block is concerned. Put the cursor on the code to generate the javadoc for, then `Help > Find Action...` then start typing "Fix doc comment". Once it's selected, press Enter to execute the action and generate the text. You can also go into the keybindings menu, search for the same action, and assign a keybinding to it. (I *think* the text inserted is based on the Live Templates, but I don't do this often enough to tell or care.) – Ti Strga Apr 21 '20 at 13:58

aelkz · Answer 2 · 2019-09-17T14:14:07.577

36

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.

edited Sep 17 '19 at 14:14

answered Jul 27 '17 at 16:06

aelkz

1,786
1
24
26

2

Of course, it is **very annoying** to manually invoke the _create Javadoc stubs _ command for each property, method, ... – Tom Jul 23 '19 at 19:46

score 11 · Accepted Answer · answered Dec 03 '09 at 21:58

11

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

answered Dec 03 '09 at 21:58

CrazyCoder

389,263
172
990
904

2

Thanks. That's a weird ommision by JetBrains. I will vote on friday. But the ticket does not concern _automatically_ adding javadoc for generated stuff. Maybe there is a plugin for this and that? – KarolDepka Dec 03 '09 at 23:07
7

IDEA doesn't generate JavaDoc stubs automatically, only when you type /** and press Enter. There is an old IDEA doc plug-in not compatible with the recent IDEA versions: http://plugins.intellij.net/plugin/?id=952 . Maybe someone will rewrite it. – CrazyCoder Dec 03 '09 at 23:48

score 8 · Answer 4 · answered Jul 26 '13 at 09:16

8

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

answered Jul 26 '13 at 09:16

Rinkesh

3,150
28
32

13

The user isn't asking how to generate the doc themselves. They want to know how to create the comments in the java code. – b3labs Apr 25 '17 at 16:45
2

Nevertheless quite helpful! – JFreeman Mar 17 '21 at 07:38

score 4 · Answer 5 · answered Nov 13 '20 at 08:50

4

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

answered Nov 13 '20 at 08:50

Damian

81
3

Thanks. I use this just now on my mac and it integrated right into the generate menu. – K. hervey Sep 24 '21 at 18:48

score 3 · Answer 6 · answered Apr 24 '19 at 18:47

3

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.

answered Apr 24 '19 at 18:47

Evvo

481
5
8

score 2 · Answer 7 · answered Jan 23 '11 at 10:39

2

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.

answered Jan 23 '11 at 10:39

Alexey Shuk

21
1

I have installed this plugin but could not find a way to generate comments for all methods in a class. Could you please tell me how to do it? – ashisahu Sep 22 '16 at 20:01
Version #10 of Plugin exists now. The helps says to turn on the JavaDoc Sync plugin, go to Settings->Errors and select "JavaDoc issues". But there is no Errors under settings :-( Uninstalled and used @chance solution – boardtc Apr 09 '20 at 15:01
the #10 ver seems to be at https://plugins.jetbrains.com/plugin/6340-javadoc-sync-plugin-10 – George Birbilis Jun 07 '21 at 06:28

Ahmad Sajadian · Answer 8 · 2020-05-05T12:23:31.187

1

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.

edited May 05 '20 at 12:23

answered May 05 '20 at 06:47

Ahmad Sajadian

29
3

score 0 · Answer 9 · edited Sep 27 '19 at 08:37

0

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

edited Sep 27 '19 at 08:37

RobC

22,977
20
73
80

answered Sep 27 '19 at 08:14

Ivo Varbanov

59
1
3

Intellij generate javadoc for methods and classes

9 Answers9

Linked

Related