dion 02/03/29 05:27:38
Modified: docs/latka developers-guide.html
Log:
Added Rodney's development style comments
Revision Changes Path
1.7 +6 -8 jakarta-commons/docs/latka/developers-guide.html
Index: developers-guide.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/latka/developers-guide.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- developers-guide.html 25 Mar 2002 22:09:20 -0000 1.6
+++ developers-guide.html 29 Mar 2002 13:27:38 -0000 1.7
@@ -6,23 +6,21 @@
on <a href="index.html">Latka</a>. Hopefully they will make sense to
those coming after me, and possibly clarify the current state for the existing
</p>
- <p>This should probably be set out (from the source side) more
-like a book than a chapter</p>
- <p>That said, on with the disorganised discourse</p>
</blockquote></td></tr></table><table width="100%" cellpadding="2"
cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font
face="arial,helvetica.sanserif" color="#ffffff"><a
name="Coding%20Style"><strong>Coding
Style</strong></a></font></td></tr><tr><td><blockquote>
- <p>Latka has some unusual coding conventions, which I'm trying to
-capture at the moment using a tool, <a
href="http://checkstyle.sourceforge.net";>CheckStyle</a>. Since I'm not quite
-sure what all the conventions are myself, nothing is really authoratative except
-the source code</p>
+ <p>Latka has some unusual coding conventions, which we've hopefully
+captured using a tool, <a href="http://checkstyle.sourceforge.net";>CheckStyle
+</a>.</p>
<p>Onto the conventions... The Sun coding conventions are followed in
most places, except for the items that follow</p>
<ul>
<li><p>private and protected member variables begin with an
underscore, <div align="left"><table border="0" cellpadding="0"
cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0"
hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td><td height="1"
bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1"
src="/images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0"
hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td></tr><tr><td
width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1"
src="/images/void.gif"></td><td height="1"
bgcolor="#ffffff"><pre>_requestSucceeded</pre></td><td width="1"
bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1"
src="/images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img
border="0" hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td><td
height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1"
width="1" src="/images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img
border="0" hspace="0" vspace="0" height="1" width="1"
src="/images/void.gif"></td></tr></table></div></p></li>
- <li><p>private methods also begin with an underscore</p>
+ <li><p>private methods also begin with an underscore on
+rare occasions (mainly when there is some public method and protected/private
+method with an otherwise identical signature)</p>
</li>
<li><p>Javadoc on classes and methods is not yet complete.
Feel free to help out here :-)</p></li>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
