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)?

Solution 1

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.

Solution 2

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

Solution 3

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:

Solution 4

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.

View more solutions

Comments

[mattbdean]

If you were using Eclipse I'd recommend JAutoDoc.

[Will Humphreys]

You can now edit comments on templates. See the answer below. stackoverflow.com/a/38094408/2377639

[Dr4gon]

Works like a charm :D