Apache/commons-collections
1
0
Fork 0
mirror of https://github.com/apache/commons-collections.git synced 2025-02-16 15:07:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add coding standards section

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131829 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-12-19 21:43:26 +00:00
parent 2e2ac4ba93
commit 51fb664dd1
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
DEVELOPERS-GUIDE.html
View File

@ -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: DEVELOPERS-GUIDE.html,v 1.4 2004/02/19 21:41:04 scolebourne Exp $<br>
$Id: DEVELOPERS-GUIDE.html,v 1.5 2004/12/19 21:43:26 scolebourne Exp $<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 @@ inner classes, or as public classes in a subpackage. If a subpackage is used,
the constructors should be protected and a public static decorate() method
provided on each class for construction.</p>
<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>