[Jrefactory-users] Enhancement proposal: Block definition comments

[Carsten H. <ca...@pi...>]

Hi Jrefactory users and programmer!

I stumbled across jrefactory some time ago and found the time to look at
it last week.
It's a great tool! I hope to use it regulary in the future.
We follow the java coding convetions closelay, so the pretty printing
works
good for us with only a few problems.

One of them is what we call a block definition comment.
When deleoping software based on standards you often have the case that
a lot of constants need to be defined which are well known and defined
in the
standards document.
So we commonly have code like the following

/**
* some tenths of constants as defined by document foo
*/
public final static String FOO_MyConstantForPurpose1 = ...
public final static String FOO_MyConstantForPurpose2 = ...
public final static String FOO_MyConstantForPurpose3 = ...
public final static String FOO_MyConstantForPurpose4 = ...
public final static String FOO_MyConstantForPurpose5 = ...
public final static String FOO_MyConstantForPurpose6 = ...
public final static String FOO_MyConstantForPurpose7 = ...
public final static String FOO_MyConstantForPurpose8 = ...
...

It's a waste of time to add documentation to each of the constants,
the comment above is all they need.

So may proposal:
    Add support for something like blockDefinitionComments=true to the
parser and the pretty printer
    which behaves as described above.

If someone give me a rough hint where and how to add that to the code
(something along: add an attribute to class xy, and add some code in
class xy2 would be enough)
I may do that myself.

Ciao,
    Carsten Heyl


--
  Carsten Heyl                          ca...@pi...
  Pixelboxx GmbH                        http://www.pixelboxx.de/
  Ostenhellweg 56-58                    Tel.:   +49 231 53 46 30
D-44135 Dortmund                        Mobile: +49 174 31 83 608