How to generate javadoc comments in Android Studio

Question

Can I use shortcut keys in Android studio to generate javadoc comments?

If not, what is the easiest way to generate javadoc comments?

This question is 50/50. You ar eeither looking for single javadoc blocks of generating javadoc throughout the document. Which is it? — basickarl, Jun 04 '15 at 16:24
ALTR + ENTER show the view you can generate the comment of already declared methods. — Zala Janaksinh, Jan 01 '16 at 05:34
May be you should add a Live template(Android studio - setting - editor - Live Templates - add)for it. In the template text field add the following text. /** * $comment$ */ — Johnett Mathew, Aug 10 '17 at 11:28

DouO · Accepted Answer · 2022-04-05T06:02:44.267

434

I can't find any shortcut to generate javadoc comments. But if you type /** before the method declaration and press Enter, the javadoc comment block will be generated automatically.

Read this for more information.

edited Apr 05 '22 at 06:02

answered Jun 28 '13 at 01:33

DouO

4,914
1
20
29

7

It's a shame that this doesn't also work to generate javadoc comments for classes, fields, etc. It would be even nicer if it generated javadoc from a customizable template. – Ted Hopp Jan 30 '15 at 21:40
28

of course it has shortcut: position on method/constructor name and press alt+enter, choose generate javadoc from menu – Ewoks Aug 09 '16 at 13:55
refer [this](https://tips.androidhive.info/2015/04/how-to-auto-generate-comments-for-your-android-functions-android-studio/) more about above solution – Pritesh Vishwakarma Jan 29 '19 at 09:24
1

@Ewoks [Doesn't work](https://i.imgur.com/Fnuwk0K.png) for me. – AndreKR Nov 04 '22 at 18:29

score 124 · Answer 2 · edited Feb 05 '18 at 11:59

124

To generatae comments type /** key before the method declaration and press Enter. It will generage javadoc comment.

Example:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

For more information check the link https://www.jetbrains.com/idea/features/javadoc.html

edited Feb 05 '18 at 11:59

Johnny Five

987
1
14
29

answered Dec 09 '14 at 12:54

Amey Haldankar

2,223
1
24
22

3

@satheeshwaran - for what it's worth, I can see that just seeing the example of the comments (in the answer) is useful, when one wants an answer quickly ;-) – CJBS Jan 09 '15 at 18:14
Actually the example lacks an * before the last / – Maximiliano Ambrosini Feb 23 '17 at 14:45
Kotlin support: https://stackoverflow.com/questions/40574195/generate-kdoc-for-methods-in-android-studio. – CoolMind Oct 12 '21 at 21:15

Suragch · Answer 3 · 2017-09-14T08:23:36.527

Here is an example of a JavaDoc comment from Oracle:

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

The basic format can be auto generated in either of the following ways:

Position the cursor above the method and type /** + Enter
Position the cursor on the method name and press Alt + Enter > click Add JavaDoc

I came here because I knew this method from PhpStorm but in Android Studio it [doesn't work](https://i.imgur.com/Fnuwk0K.png). — AndreKR, Nov 04 '22 at 18:30
Is there any shortcut to Add Javadoc to all the methods in the class ??? — KK_07k11A0585, Jul 28 '23 at 12:37

darwin · Answer 4 · 2016-04-19T11:28:24.590

18

You can install JavaDoc plugin from Settings->Plugin->Browse repositories.

get plugin documentation from the below link

JavaDoc plugin document

edited Apr 19 '16 at 11:28

answered Apr 19 '16 at 11:03

darwin

1,524
1
22
32

1

This works great. Install JavaDoc plugin (as above), then press CNTL + SHIFT + ALT + G. – Alan Nelson Nov 20 '16 at 23:21
for kotlin refer the following link https://kotlinlang.org/docs/reference/kotlin-doc.html – darwin Jan 24 '21 at 04:15
For Kotlin: https://stackoverflow.com/questions/40574195/generate-kdoc-for-methods-in-android-studio. – CoolMind Oct 12 '21 at 21:16

score 12 · Answer 5 · edited Sep 08 '18 at 18:49

12

Javadoc comments can be automatically appended by using your IDE's autocomplete feature. Try typing /** and hitting Enter to generate a sample Javadoc comment.

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */

edited Sep 08 '18 at 18:49

user7401478

1,372
1
8
25

answered Sep 08 '18 at 14:21

Kuldeep Kumar

754
1
7
12

score 10 · Answer 6 · answered Mar 27 '15 at 20:14

10

You can use eclipse style of JavaDoc comment generation through "Fix doc comment". Open "Preference" -> "Keymap" and assign "Fix doc comment" action to a key that you want.

answered Mar 27 '15 at 20:14

Kohei Mikami

2,850
24
21

Mr.India · Answer 7 · 2016-04-14T14:29:29.927

Here we can some something like this. And instead of using any shortcut we can write "default" comments at class/ package /project level. And modify as per requirement

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

Advantage is that, you can create comment block for all the methods at a time.

score 5 · Answer 8 · answered Jun 03 '14 at 20:43

In Android Studio you don't need the plug in. On A Mac just open Android Studio -> click Android Studio in the top bar -> click Prefrences -> find File and Code Templates in the list -> select includes -> build it and will be persistent in all your project

huu duy · Answer 9 · 2016-03-17T17:13:30.290

3

Another way to add java docs comment is press : Ctrl + Shift + A >> show a popup >> type : Add javadocs >> Enter .
Ctrl + Shirt + A: Command look-up (autocomplete command name)

edited Mar 17 '16 at 17:13

answered Nov 13 '15 at 08:13

huu duy

2,049
21
31

yoAlex5 · Answer 10 · 2022-01-10T20:15:54.627

3

Add Javadoc

/** + return
set cursor inside method name -> ⌥ Option + return -> Add Javadoc

edited Jan 10 '22 at 20:15

answered May 30 '21 at 14:29

yoAlex5

29,217
8
193
205

score 2 · Answer 11 · answered Sep 01 '16 at 19:10

2

Simply select (i.e. click) the method name, then use the key combo Alt+Enter, select "Add JavaDoc"

This assumes that you have not already added comments above the method, else the "Add JavaDoc" option will not appear.

answered Sep 01 '16 at 19:10

Jim Robbins

116
4

Noir · Answer 12 · 2018-03-01T08:50:16.333

In Android studio we have few ways to auto-generated comments:

Method I:

By typing /** and Then pressing Enter you can generate next comment line and it will auto-generate the params, etc. but when you need the hotkey for this check out method II on below.

**Method II: **

1 - Goto topMenu

2 - File > Settings

3 - Select Keymap from settings

4 - On the top right search bar search for "Fix Doc"

5 - Select the "fix doc comment" from the results and double-click on it

6 - Select Add keyboard shortcut from the opened drop down after double-click

7 - Press the shortcut keys on the keyboard

8 - Goto your code and where you want to add some comment press the shortcut key

9 - Enjoy!

The most convinuent way to add docs. E.g. I ve assigned " ' " and Enter as the shortcut — CodeToLife, May 21 '19 at 13:15

score 1 · Answer 13 · answered Feb 11 '14 at 17:03

1

Just select the Eclipse version of the keycap in the Keymap settings. An Eclipse Keymap is included in Android Studio.

answered Feb 11 '14 at 17:03

Brill Pappin

4,692
1
36
36

score 1 · Answer 14 · answered Oct 14 '19 at 02:29

1

i recommendated Dokka for geneate javadoc with comment and more

answered Oct 14 '19 at 02:29

Yudi karma

324
3
15

score 0 · Answer 15 · answered Jun 25 '13 at 07:49

0

I'm not sure I completely understand the question, but a list of keyboard short cuts can be found here - Hope this helps!

answered Jun 25 '13 at 07:49

laminatefish

5,197
5
38
70

2

In eclipse to add javadoc comments press Alt + shift + j, but in AndroidStudio but I don't know how to do – qinxianyuzou Jun 25 '13 at 16:32
If I recall, that shortcut only worked if you had the 'jautodoc' plugin installed and enabled. – Matt Dec 04 '13 at 19:05

score 0 · Answer 16 · answered May 31 '18 at 08:18

0

Android Studio -> Preferences -> Editor -> Intentions -> Java -> Declaration -> Enable "Add JavaDoc"

And, While selecting Methods to Implement (Ctrl/Cmd + i), on the left bottom, you should be seeing checkbox to enable Copy JavaDoc.

answered May 31 '18 at 08:18

Mahi

472
5
7

score 0 · Answer 17 · answered Oct 12 '21 at 21:12

Because almost of us use Kotlin, you can generate JavaDoc (KDoc) using plugins. In Android Studio open Settings (press Ctrl+Alt+S), select Plugins and find kdoc. I downloaded KDoc-er, but you can choose any of them. Then restart Android Studio.

Find any class/method, type /**, press Enter. You will get a short description like:

/**
 * User data
 *
 * @property name
 * @property avatar
 * @property gender
 * @constructor Create empty User data
 */
class UserData(...

score -1 · Answer 18 · answered Oct 16 '21 at 15:57

-1

to generate javadoc comment use /** Your docs */

answered Oct 16 '21 at 15:57

jay

15
3

This has already been mentioned *and explained in detail* in the other answers. *When answering older questions that already have answers, please make sure you provide either a novel solution or a significantly better explanation than existing answers.* – Eric Aya Oct 16 '21 at 20:45

score -5 · Answer 19 · edited Apr 09 '15 at 20:10

-5

ALT+SHIFT+G will create the auto generated comments for your method (place the cursor at starting position of your method).

edited Apr 09 '15 at 20:10

James Skemp

8,018
9
64
107

answered Mar 12 '15 at 12:52

Dinesh IT

87
2

public void hideKeyboard() u should place the cursor in front of public and try it or please check whether u installed the java doc in your studio. – Dinesh IT Mar 23 '15 at 06:17
It is not working for me either. Maybe, it is working in some special keymap. The keymap can be configured in Preferences > Keymap. Or the keymap has been edited. – Oliver Kranz Sep 17 '15 at 08:12

How to generate javadoc comments in Android Studio

19 Answers19

Linked