Adding author name in Eclipse automatically to existing files

Question

Is there a real easy to use tool (no monster tool) that I can plug into Eclipse, and press a "generate header" button and then the authors name appears in every file in that project?

Solution 1

Actually in Eclipse Indigo thru Oxygen, you have to go to the Types template Window -> Preferences -> Java -> Code Style -> Code templates -> (in right-hand pane) Comments -> double-click Types and make sure it has the following, which it should have by default:

/**
 * @author ${user}
 *
 * ${tags}
 */

and as far as I can tell, there is nothing in Eclipse to add the javadoc automatically to existing files in one batch. You could easily do it from the command line with sed & awk but that's another question.

If you are prepared to open each file individually, then selected the class / interface declaration line, e.g. public class AdamsClass { and then hit the key combo Shift + Alt + J and that will insert a new javadoc comment above, along with the author tag for your user. To experiment with other settings, go to Windows->Preferences->Java->Editor->Templates.

Solution 2

To old files I don't know how to do it... I think you will need a script to go thru all files and add the header.

To change the new ones you can do this.

Go to Eclipse menu bar

1. Window menu.
2. Preferences
3. search for Templates
4. go to Code templates
5. click on +code
6. Click on New Java files
7. Click Edit
8. add

/**
${user}
*/

And it's done every new File will have your name on it !

Solution 3

Shift + Alt + J will help you add author name in existing file.

To add author name automatically,
go to Preferences --> java --> Code Style --> Code Templates

in case you don't find above option in new versions of Eclipse - install it from https://marketplace.eclipse.org/content/jautodoc

Solution 4

You can control select all customised classes and methods, and right-click, choose "Source", then select "Generate Element Comment". You should get what you want.

If you want to modify the Code Template then you can go to Preferences -- Java -- Code Style -- Code Templates, then do whatever you want.

Solution 5

Quick and in some cases error-prone solution:

Find Regexp: (?sm)(.*?)([^\n]*\b(class|interface|enum)\b.*)

Replace: $1/**\n * \n * @author <a href="mailto:[email protected]">John Smith</a>\n */\n$2

This will add the header to the first encountered class/interface/enum in the file. Class should have no existing header yet.

View more solutions

Comments

[Andy Thomas]

Note: Author reports that the files already exist. Eclipse Code Templates don't solve this problem.

[Andy Thomas]

This question is for files that already exist.

[Universe]

ADDING HELP To find the Comments ->Types Go to Window -> Preferences -> Java -> Code Style -> Code templates in the window will appear the Comments drop-down

[Adam]

thanks @Universe - now updated.

[gonephishing]

shift+alt+j, that was what i was looking for :)

[lordscales91]

It's important to mention that if the class is annotated the JavaDoc will be placed after the annotations, which is still a valid syntax but probably will not pass PMD Checkstyles.

[mannedear]

Thats right! Tick for Automatically add comments... is good for including author name in newly creating files.

[Marcelo Rebouças]

Very useful. There are any shortcut to sign the method?? Thanks!

[Ripudaman Singh]

For Mac user's the key combination is: option+command+J