db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Kathey Marsden <kmarsdende...@sbcglobal.net>
Subject Re: [jira] Commented: (DERBY-1363) Derby should publish a well defined coding convention per the db project guidlines
Date Fri, 04 Aug 2006 17:40:45 GMT
Mike Matrigali wrote:

> I still don't think it is worth it to reformat all the code style, but
> do think addressing the tab/space issue is worth it. 

My hope is to address this incrementally.  My only goal right now is to 
do define a long term coding style for the project and for new code.
I'd rather not include  repainting the shed in the discussion right now, 
just deciding on a color.  I am not proposing code reformatting at this 
time.
 
After this current effort , the contributor checklist  might say the 
following about Coding Standards and Tabs

Coding Standards

The Derby community will use the [ snip decided standard] moving 
forward.  New code should conform to this standard.  However, there is a 
great deal of existing code that does not match this standard.  Changes 
to existing code should match the surrounding code for readability, 
matching tabs or spaces as appropriate (see Tabs)

Tabs
Most of the existing code that has tabs expect tab-width to be set to 4 
spaces.   This was the original Cloudscape convention.  With this 
setting your code should look readable.   When editing existing code 
with tabs, use tabs and set your tab-width to 4.  After editing,  set 
tabs back to 8 or view with a simple text editor to make sure the code 
indentation is consistent.

Right now the proposed [snip decided standard] is

 Code Conventions for the Java Programming Language 
<http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html> as 
published by Sun [1]  with four space indent (no tabs)

Any objections? Once we  fill in [snip decided standard] with something 
that can get through without veto we can try to make additional progress 
on the issue.   Having a long term destination is an important first 
step, even if our path will still be filled with tripwires.  Right now 
we are tripping in every direction.  After deciding the  base color for 
our shed long term we can discuss optional trim and the impact of 
actually repainting is worth it.

Thanks

Kathey

[1] http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html



Mime
View raw message