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?

Note: Author reports that the files already exist. Eclipse Code Templates don't solve this problem. — Andy Thomas, Oct 31 '11 at 19:27

score 74 · Accepted Answer · edited May 30 '18 at 11:58

74

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.

edited May 30 '18 at 11:58

hata

11,633
6
46
69

answered Oct 10 '12 at 09:58

Adam

5,215
5
51
90

11

**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 – Universe Aug 15 '14 at 11:29
thanks @Universe - now updated. – Adam Feb 29 '16 at 12:37
Very useful. There are any shortcut to sign the method?? Thanks! – Marcelo Rebouças Oct 25 '18 at 13:23
after I make these changes, is there a way to retrospectively generate authorship comments at the top in older java files ? – KNU May 19 '23 at 11:07

score 46 · Answer 2 · edited Jul 23 '14 at 11:27

46

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

Window menu.
Preferences
search for Templates
go to Code templates
click on +code
Click on New Java files
Click Edit
add

/**
${user}
*/

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

edited Jul 23 '14 at 11:27

Sufian

6,405
16
66
120

answered Oct 31 '11 at 19:46

Cristiano Fontes

4,920
6
43
76

4

This question is for files that already exist. – Andy Thomas Oct 31 '11 at 21:26

rinuthomaz · Answer 3 · 2017-07-07T09:24:14.103

36

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

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

edited Jul 07 '17 at 09:24

answered Jun 06 '14 at 12:18

rinuthomaz

1,393
2
23
38

1

shift+alt+j, that was what i was looking for :) – gonephishing Mar 18 '16 at 16:29
Thats right! Tick for `Automatically add comments...` is good for including author name in newly creating files. – Suresh Aug 12 '18 at 15:23
For Mac user's the key combination is: option+command+J – Ripudaman Singh May 15 '20 at 10:05

score 5 · Answer 4 · answered Jul 03 '13 at 02:08

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.

score 3 · Answer 5 · answered Feb 25 '14 at 07:53

3

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:j.smith@acme.com">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.

answered Feb 25 '14 at 07:53

Martin Ždila

2,998
3
31
35

1

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. – lordscales91 Nov 03 '17 at 08:47

Adding author name in Eclipse automatically to existing files

5 Answers5

Linked