commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/collections DEVELOPERS-GUIDE.html
Date Sun, 19 Dec 2004 21:43:26 GMT
scolebourne    2004/12/19 13:43:26

  Modified:    collections DEVELOPERS-GUIDE.html
  Log:
  Add coding standards section
  
  Revision  Changes    Path
  1.5       +23 -5     jakarta-commons/collections/DEVELOPERS-GUIDE.html
  
  Index: DEVELOPERS-GUIDE.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/DEVELOPERS-GUIDE.html,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- DEVELOPERS-GUIDE.html	19 Feb 2004 21:41:04 -0000	1.4
  +++ DEVELOPERS-GUIDE.html	19 Dec 2004 21:43:26 -0000	1.5
  @@ -16,19 +16,21 @@
   <html>
   <head>
   <title>Developers guide for Jakarta Commons "Collections" Package</title>
  -<head>
  +</head>
   <body bgcolor="white">
   
   
   <div align="center">
   <h1>The Jakarta Commons <em>Collections</em> Package</h1>
   <h2>Developers Guide</h2>
  -$Id$<br>
  +$Id$<br />
   <a href="#Introduction">[Introduction]</a>
   <a href="#CollectionInterfaces">[Collection Interfaces]</a>
   <a href="#CollectionImplementations">[Collection Implementations]</a>
   <a href="#UtilityClasses">[Utility Classes]</a>
  -<br><br>
  +<a href="#CodingStandards">[Coding Standards]</a>
  +<br />
  +<br />
   </div>
   
   
  @@ -109,7 +111,23 @@
   the constructors should be protected and a public static decorate() method
   provided on each class for construction.</p>
   
  -</body>
  -</html>
  +<a name="CodingStandards"></a>
  +<h3>5. CODING STANDARDS</h3>
  +
  +<p>Commons Collections follows similar style rules to many other Java open source
  +projects, and the Sun conventions. Some specific conventions are:</p>
  +
  +<ul>
  +<li>No tabs, 4 space indentations</li>
  +<li>Curly brackets open at line end</li>
  +<li>Else, catch and finally statements after the closing bracket</li>
  +<li>Single space after keyword such as if</li>
  +<li>Two spaces between parameter name and description in @param</li>
  +<li>Generally copy the style of the surounding code</li>
  +</ul>
   
  +<p>And rememeber, the commons-dev mailing list is there for any discussions
  +or queries about patches or new additions to collections.</p>
   
  +</body>
  +</html>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message