129

I dislike the default Javadocs generated for me when I create a Class or methods, especially the @author variable, which is the current system username on my windows box.

I would like to change it. Is this possible?

Improve this question
2
  • 2
    For the @author variable customization, you can set up your custom string by editing eclipse.ini file adding -Duser.name=customstring (Tested in Kepler / Luna) Commented Feb 27, 2015 at 3:42
  • 3
    You better get rid of @author tag, as it is an unwanted noise. Commented Sep 13, 2017 at 10:01

5 Answers 5

Reset to default
193

Check Preferences / Java / Code Style / Code Template

Section Comment / Type

You can replace the author tag by whatever value you need and it will have an effect on new generated classes.

Code Templates

However, if the template is fine, but the value referenced buy the author tag is not, see this SO question:

${user} uses the value of the user.name environment variable; therefore, you can pass -Duser.name=My Name in eclipse.ini to override it.

Or, if you prefer, you can modify the shortcut to point to:

C:/java/eclipse/eclipse.exe -vmargs -Duser.name="cleverUserNameToUseInSourceCode"
  • MacOs: Aram Kocharyan mentions the eclipse.ini is in Eclipse.app/Contents/MacOS/ if you right click and go Show Package Content.
  • ZendStudio: rofflox comments the file is named ZendStudio.ini and is found in Applications/Zend Studio.app/Contents/MacOS/.
Improve this answer
Sign up to request clarification or add additional context in comments.

9 Comments

Unrelated: How did you generate such a pretty screenshot?
@Paul: after that meme revealed itself as "mandatory" (meta.stackexchange.com/questions/19478/the-many-memes-of-meta/…), I had to use FSCapture (faststone.org/FSCaptureDetail.htm) to comply ;)
Snipping Tool does the trick on Win7. Thanks for the screenshot. This is just what I needed tonight! :)
For Mac users, eclipse.ini is in Eclipse.app/Contents/MacOS/ if you right click and go Show Package Contents
The same goes for Zend Studio for Mac. The ZendStudio.ini is found in Applications/Zend Studio.app/Contents/MacOS/.
|
6

Look at Window -> Preferences -> Java -> Editor -> Templates.

Improve this answer

1 Comment

Yeah I know about that, but unfortunately this does not seem to have any effect on the code generation for Classes. I want to avoid having to do this manually
3

Spring Tool Suite (popular Eclipse customization for Spring development) uses STS.ini. On Windows I found it in the same dir as an app launch executable.

Improve this answer

1 Comment

For STS on Mac OS see VonC's answer while searching through the STS application package.
3

To use a Git username and email you can use the variables ${name:git_config(user.name)} and ${email:git_config(user.email)}.

enter image description here

Improve this answer

1 Comment

This is located under Preferences / Java / Code Style / Code Templates / Comments / Types
1

You should consider using JAutodoc, which is a very useful plugin for Eclipse. The parametrization is way more advanced than the standard Eclipse generation.

Improve this answer

1 Comment

Is there a way to replace the eclipse javadoc generation of eclipse with JAutoDoc? What I mean is: I have installing the JAutoDoc plugin. If I now generate get/setter methods via Shft+Alt+S and selecting "Generate Getters and Setters..." the javadoc comments are still generated by eclipse. But I want to generate this comments by JAutoDoc automatically...

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.