Java Comments Generation

To enable javadoc comments in your IDE, go to

project-->properties-->Java Code Style-->Code Templates.



In code templates, set the comment pattern for individual comment type.

For example, you need to set the comment type for Method, then click on edit
and give the pattern

/**

* return Returns the ${return_type}

*/

and save the settings. In your "file.java", on the method do alt+shift+j to get the comment for the method.


Please ensure that we have comments for every variable, method etc in our files.

NOTE:

Kindly use the below pattern

/**

* ${tags} Returns the ${return_type}

*/

As it produces results like

/**

* @param objRequestDTO

* @return Returns the RequestDTO

*/

With the below pattern

/**

* return Returns the ${return_type}

*/

The output will be

/**

* return Returns the RequestDTO

*/