I'd vote for disabling formatting of comments. That's one thing that
humans still generally do a better job of managing.
Scott
Luke Taylor wrote:
> Hi all,
>
> I have a couple of suggestions for our Jalopy policy. Generally, I'm not
> too fussed about the details of code formatting standards but there are
> a couple of things about our current Jalopy formatting that I find annoying.
>
> The main one is comments. I usually read comments directly in the source
> code rather than as Javadoc, but Jalopy seems happy to throw away any
> extra spacing and layout in comments in the assumption that they'll end
> up as HTML anyway, making them a lot harder to read in the source. It
> also seems happy to trash the contents of <pre> tags as illustrated in
> the following before and after versions:
>
> http://acegisecurity.svn.sourceforge.net/viewvc/acegisecurity/trunk/acegisecurity/core/src/test/java/org/acegisecurity/providers/x509/X509TestUtils.java?revision=679&view=markup
>
> http://acegisecurity.svn.sourceforge.net/viewvc/acegisecurity/trunk/acegisecurity/core/src/test/java/org/acegisecurity/providers/x509/X509TestUtils.java?view=markup
>
> I'd like to suggest that we disable formatting of comments, or rein it
> in a bit.
>
> The other (more minor) thing is that the indentation of the "throws"
> clause which I often find makes it hard to immediately pick out the
> start of a method body.
>
> public static X509AuthenticationToken createToken()
> throws Exception {
> return new X509AuthenticationToken(buildTestCertificate());
> }
>
> (Ok, not that hard :). I think this would be clearer if it used a
> different indentation or a blank line at the start of the method.
>
> What do you guys think (especially on the comment formatting bit) ?
>
> Luke.
>
>
>
>
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Home: http://acegisecurity.org
Acegisecurity-developer mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/acegisecurity-developer
