Following this post I've been doing some investigating.
The code editing package jEdit <http://jedit.sourceforge.net/> uses an optional
JavaStyle plugin which automatically enforces most coding standards and can be
configured to various preferences. (By enforces, I mean that it automatically
reformats code to meet a standard, and can automatically do so on a whole directory of
source code.) The engine behind this is a PrettyPrinter by Chris Seguin which is part
of a collection of Java source code refactoring tools (JRefactory)
<http://users.snip.net/~aseguin/cspretty.html>. This code is currently GPLd.
I have had a brief correspondence with Chris to see what his reaction would be to the
idea of incorporating his code into Ant (and therefore expanding the license - if my
understanding of licenses is correct). His response has been quite open so far.
My thought is, if we could add this tool to Ant we could provide an automated
mechanism for conforming any Apache project to a particular coding standard (including
dealing with those nasties like tabs vs. spaces). The PrettyPrinter code also
includes facilities for producing default Javadoc comments for uncommented code
matching particular criteria (e.g. only public methods..). This kind of automated
conformance seems such a nice idea for open source development.
What would your reaction be to this idea? Is it worth pursuing or have I missed some
practical limitation?
Stuart.
On Tuesday, January 16, 2001, at 09:46 AM, Charles Benett wrote:
> Serge,
> Good idea to add a coding standards doc, but ...
> I'd strongly prefer we stick with the Sun Java coding convention for
> brackets, e.g.:
>
> if (foo) {
> //statements
> }
>
> etc (section 7 of code conventions).
> I think its easier to read, saves a line per keyword and its easier to
> tell people to follow Sun standard than Sun standard with fixes.
>
> Charles
>
>
> ------------------------------------------------------------
> To subscribe: [EMAIL PROTECTED]
> To unsubscribe: [EMAIL PROTECTED]
> Archives: <http://www.mail-archive.com/james%40list.working-dogs.com/>
> Problems?: [EMAIL PROTECTED]
>
>
-------------------------------------------------------------------------
Stuart Roebuck [EMAIL PROTECTED]
Lead Developer Java, XML, MacOS X, XP, etc.
ADOLOS http://www.adolos.com/
------------------------------------------------------------
To subscribe: [EMAIL PROTECTED]
To unsubscribe: [EMAIL PROTECTED]
Archives: <http://www.mail-archive.com/james%40list.working-dogs.com/>
Problems?: [EMAIL PROTECTED]
