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

Answer 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.

Answer 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