db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "DerbyContributorChecklist" by KatheyMarsden
Date Sat, 05 Aug 2006 04:34:47 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for change notification.

The following page has been changed by KatheyMarsden:
http://wiki.apache.org/db-derby/DerbyContributorChecklist

------------------------------------------------------------------------------
  ||Tests||Don't forget to include regression tests with your code patch.||
  ||Coding Standards||The Derby community has not approved a common body of coding standards.
Individual contributors have found the following standards useful: [http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
 Java Coding Standards] and [http://wiki.apache.org/geronimo/CodingStandards  Geronimo Coding
Standards]. For example, not including @author tags and limiting line lengths to 80 characters
is encouraged by several Derby committers.||
  ||Comments||Make sure you comment your code. Pay special attention to @param and @return
tags in method Javadocs. [http://java.sun.com/j2se/javadoc/writingdoccomments/ How to Write
Doc Comments for the Javadoc Tool] may be a good source of reference if you are not sure how
to write Javadoc.||
- ||Tabs||Set your tabs at 4 spaces. This was the original Cloudscape convention. With this
setting your code should look readable.||
+ ||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. ||
  

Mime
View raw message