Java doc template

Question

I'm trying to put Java comments and I have used for that Java doc tamplate and STS tool : In STS I'm using that configuration in Java doc tamplate:-

/**
 * Description: 
 * Name of Project: ${project_name}
 * Created on: ${date} ${time}
 * Modified on: ${date} ${time}
 * @author ${user}
 * Version: 1.0
 * ${tags}
 */

Which displays the following on my Java file.

/**
 * Description: 
 * Name of Project: CabFMS
 * Created on: Oct 29, 2012 4:05:38 PM
 * Modified on: Oct 29, 2012 4:05:38 PM
 * @author tgupta1
 * Version: 1.0
 */

Here, I want to update the version dynamically just like date, time, user, project_name etc.

Please suggest me, is there a way for that or we need to do it manually?

Here you may find the answer. http://stackoverflow.com/questions/2612633/how-do-i-change-the-javadocs-template-generated-in-eclipse — Mustafa Genç, Oct 29 '12 at 12:16
So do you want the comment to automatically update the version number when someone makes a change? — The Cat, Oct 29 '12 at 12:18
Sorry, what is STS? [Wikipedia's list](http://en.wikipedia.org/wiki/STS_(disambiguation)) doesn't show anything I could recognize as fitting. — Paŭlo Ebermann, Nov 04 '12 at 20:42
@PaŭloEbermann SpringSource Tool Suite, an Eclipse Distribution. — Sean Patrick Floyd, Nov 11 '12 at 19:27

score 0 · Answer 1 · answered Nov 11 '12 at 19:02

I think the JAutoDoc plugin might help you regenerating all the headers of your source files (if that what you are searching for).

Btw including created/modified/authors can be done easily and automatically with any source versioning systems like SVN, Git or Mercurial. However, their usage is highly discouraged (it simply cause too much noise when diffing).

Java doc template

1 Answers1