jon 01/05/14 11:35:22
Modified: docs code-standards.html
xdocs code-standards.xml
xdocs/services db-service.xml
Log:
db-service had a typo
added more code standards clarity
Revision Changes Path
1.39 +28 -11 jakarta-turbine/docs/code-standards.html
Index: code-standards.html
===================================================================
RCS file: /home/cvs/jakarta-turbine/docs/code-standards.html,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -r1.38 -r1.39
--- code-standards.html 2001/05/13 22:29:04 1.38
+++ code-standards.html 2001/05/14 18:34:43 1.39
@@ -169,7 +169,8 @@
Java Coding Conventions</a>.
</p>
<p>
-1. Brackets should begin and end on a new line. Examples:
+1. Brackets should begin and end on a new line and should exist even
+for one line statements. Examples:
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
@@ -181,7 +182,6 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
if ( foo )
{
// code here
@@ -204,7 +204,6 @@
{
// code here
}
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -230,13 +229,11 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
if (foo)
or
if ( foo )
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -270,7 +267,7 @@
This will improve the project as a whole.
</p>
<p>
-6. The Java Apache/Turbine License <strong>MUST</strong> be placed at the top
+6. The Jakarta/Turbine License <strong>MUST</strong> be placed at the top
of each and every file.
</p>
<p>
@@ -300,7 +297,7 @@
</table>
</div>
<p>
-8. Import statements must be fully qualified for clarity.
+8. All .java files should have a @version tag like the one below.
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
@@ -312,13 +309,35 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
+@version $Id: code-standards.html,v 1.39 2001/05/14 18:34:43 jon Exp $
+</pre></td>
+ <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ </tr>
+ <tr>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ </tr>
+ </table>
+ </div>
+ <p>
+9. Import statements must be fully qualified for clarity.
+</p>
+ <div align="left">
+ <table cellspacing="4" cellpadding="0" border="0">
+ <tr>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ </tr>
+ <tr>
+ <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#ffffff"><pre>
import java.util.ArrayList;
import java.util.Hashtable;
import org.apache.foo.Bar;
import org.apache.bar.Foo;
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -342,11 +361,9 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
import java.util.*;
import org.apache.foo.*;
import org.apache.bar.*;
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
1.11 +11 -10 jakarta-turbine/xdocs/code-standards.xml
Index: code-standards.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/code-standards.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- code-standards.xml 2001/05/13 04:29:10 1.10
+++ code-standards.xml 2001/05/14 18:34:57 1.11
@@ -34,11 +34,11 @@
</p>
<p>
-1. Brackets should begin and end on a new line. Examples:
+1. Brackets should begin and end on a new line and should exist even
+for one line statements. Examples:
</p>
<source test=""><![CDATA[
-
if ( foo )
{
// code here
@@ -61,7 +61,6 @@
{
// code here
}
-
]]></source>
<p>
@@ -71,13 +70,11 @@
</p>
<source test=""><![CDATA[
-
if (foo)
or
if ( foo )
-
]]></source>
<p>
@@ -107,7 +104,7 @@
</p>
<p>
-6. The Java Apache/Turbine License <strong>MUST</strong> be placed at the top
+6. The Jakarta/Turbine License <strong>MUST</strong> be placed at the top
of each and every file.
</p>
@@ -122,17 +119,23 @@
]]></source>
<p>
-8. Import statements must be fully qualified for clarity.
+8. All .java files should have a @version tag like the one below.
</p>
<source><![CDATA[
+@version $Id: code-standards.xml,v 1.11 2001/05/14 18:34:57 jon Exp $
+]]></source>
+
+<p>
+9. Import statements must be fully qualified for clarity.
+</p>
+<source><![CDATA[
import java.util.ArrayList;
import java.util.Hashtable;
import org.apache.foo.Bar;
import org.apache.bar.Foo;
-
]]></source>
<p>
@@ -140,11 +143,9 @@
</p>
<source><![CDATA[
-
import java.util.*;
import org.apache.foo.*;
import org.apache.bar.*;
-
]]></source>
<hr noshade="true" size="1"/>
1.6 +1 -1 jakarta-turbine/xdocs/services/db-service.xml
Index: db-service.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/services/db-service.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- db-service.xml 2001/05/13 19:39:49 1.5
+++ db-service.xml 2001/05/14 18:35:09 1.6
@@ -168,7 +168,7 @@
does not fix the problem of bad code, but would help in situations where
bad code does manage to find its way into the system.
</p>
-
+</subsection>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
