How configure Intellij Idea javadoc templates?

Question

I have some method:

public int getSomeField()

I want to generate javadoc like this:

/**
* Gets {someField}
*
* @return value of {someField}
*/

Where {someField} is placeholder for field name. It is possible to create this templates for Intellij Idea (may be as live template)?

If you were using Eclipse I'd recommend [JAutoDoc](http://jautodoc.sourceforge.net/). — mattbdean, Jul 12 '13 at 05:34

score 35 · Answer 1 · edited Jun 22 '17 at 15:02

Bring up the Generate menu (Cmd+N on Mac, Alt+Insert on Windows)

Click the ellipsis in the top right hand corner.

Click the plus in the top left corner and create a new template.

Copy the contents of the old template into the new template and add the following lines to the top of it.

/**
* Gets $field.name
*
* @return value of $field.name
*/

Now when you generate the getter use the 'New Template' and you should get your getter with the JavaDoc.

maba · Answer 2 · 2013-07-12T06:14:56.430

11

You generate Javadoc by placing the caret above the method. Then you type /** and press Enter.

Unfortunately the template can't be changed and there is a request for that: http://youtrack.jetbrains.net/issue/IDEA-28206

edited Jul 12 '13 at 06:14

answered Jul 12 '13 at 06:05

maba

47,113
10
108
118

You can now edit comments on templates. See the answer below. http://stackoverflow.com/a/38094408/2377639 – Will Humphreys Jun 29 '16 at 08:47

score 9 · Answer 3 · answered Jul 12 '13 at 19:09

This will get you most of the way there.

File | Settings... | Live Templates

Press the green plus to add a new custom template.

Abbrevation: getter

Template text:

/**
 * Gets $FIELD$
 *
 * @return value of $FIELD$
 */
public $RET$ get$FIELD$()
{
    $END$
}

Applicable in Java: declaration.

Type getter where you would a method and tab complete.

The only shortcoming is I don't know how to make the first character of $FIELD$ capitalized in get$FIELD$ but none of the other locations.

Here is an image for reference:

IntelliJ Template "getter"

score 3 · Answer 4 · answered Oct 05 '18 at 08:57

3

If you want to generate the JavaDoc after the method was written (using /**), there is currently no way to customize this. Vote for issue IDEA-97658: Edit template for javadoc stub if you'd like to see this implemented.

answered Oct 05 '18 at 08:57

Sebastian

503
5
11

score 0 · Answer 5 · answered Jul 12 '13 at 18:43

Surely you can add a live template for such javadoc. The easiest way to do it is to select the whole comment and invoke "Save as live template" action (Tools menu). See http://www.jetbrains.com/phpstorm/webhelp/creating-and-editing-live-templates.html for more details.

score 0 · Answer 6 · answered Jan 23 '15 at 03:35

0

I tried the methodName() expression, but this only works while inside a method, you want the method outside of it, in the javadoc.

answered Jan 23 '15 at 03:35

Steef

569
5
21

score 0 · Answer 7 · answered Jan 28 '21 at 08:07

For completeness, to change the setter template in a similar fashion you can add this:

/**
 * Sets $field.name
 *
 * @param $paramName value of $field.name
 */

after the #set($paramName = $helper.getParamName($field, $project)) line.

This will take into account the potential parameter prefix/suffix rules from the project config.

How configure Intellij Idea javadoc templates?

7 Answers7

Linked