| CVS $Author$ and eclipse javadoc formatting: ctrl+shift+F [message #184668] |
Fri, 15 December 2006 16:50  |
Eclipse User |
|
|
|
I have been using eclipse for a couple months now and really like the
ctrl+shift+F feature: format my source code for me.
However, I've run into a problem with auto-generated comments from CVS. I
use a format like this at the top of my class files:
/**
* @author $Author$
* @version $Revision$
*
* Description of the class goes here.
*
* Revision history
* ------------------------------------------------------------
* $Log$
* ------------------------------------------------------------
*/
Unfortunately, ctrl+shift+F makes a mess of the above. Although it's not
the prettiest solution I can try this:
/**
* @author $Author$
* @version $Revision$
*
* Description of the class goes here.
*
* Revision history
* <p>
* ------------------------------------------------------------
* </p>
* <p>
* $Log$
* </p>
* <p>
* ------------------------------------------------------------
* </p>
*/
It doesn't look so nice in my eclipse text editing window but at least it
doesn't get mangled by ctrl+shift+F. However, there is one thing it still
doesn't do. The $Log$ section is not just a single entry, but becomes an
entry every time a new CVS commit occurs. It gives the version number,
author, and comments about what changes were made to get to that version.
However, in order not to get mangled by ctrl+shift+F, it needs a new <p>
and </p> for every commit, not just the first one. Any suggestions?
|
|
|
| Re: CVS $Author$ and eclipse javadoc formatting: ctrl+shift+F [message #184813 is a reply to message #184668] |
Mon, 18 December 2006 03:39  |
| Eclipse User |
|
|
|
Kai Middleton wrote:
> I have been using eclipse for a couple months now and really like the
> ctrl+shift+F feature: format my source code for me.
>
> However, I've run into a problem with auto-generated comments from
> CVS. I use a format like this at the top of my class files:
Simply uncheck to format the header comment.
Dani
>
> /**
> * @author $Author$
> * @version $Revision$
> * * Description of the class goes here.
> * * Revision history
> * ------------------------------------------------------------
> * $Log$
> * ------------------------------------------------------------ */
>
> Unfortunately, ctrl+shift+F makes a mess of the above. Although it's
> not the prettiest solution I can try this:
>
> /**
> * @author $Author$
> * @version $Revision$
> * * Description of the class goes here.
> * * Revision history
> * <p>
> * ------------------------------------------------------------
> * </p>
> * <p>
> * $Log$
> * </p>
> * <p>
> * ------------------------------------------------------------
> * </p>
> */
>
> It doesn't look so nice in my eclipse text editing window but at least
> it doesn't get mangled by ctrl+shift+F. However, there is one thing
> it still doesn't do. The $Log$ section is not just a single entry,
> but becomes an entry every time a new CVS commit occurs. It gives the
> version number, author, and comments about what changes were made to
> get to that version. However, in order not to get mangled by
> ctrl+shift+F, it needs a new <p> and </p> for every commit, not just
> the first one. Any suggestions?
>
|
|
|
Powered by
FUDForum. Page generated in 0.07504 seconds
Home