You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by di...@apache.org on 2002/03/29 11:19:15 UTC
cvs commit: jakarta-commons/latka/doc developers-guide.xml
dion 02/03/29 02:19:15
Modified: latka/doc developers-guide.xml
Log:
Added Rodney's comments on private methods and underscores
Revision Changes Path
1.7 +7 -10 jakarta-commons/latka/doc/developers-guide.xml
Index: developers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/developers-guide.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- developers-guide.xml 30 Jan 2002 05:42:02 -0000 1.6
+++ developers-guide.xml 29 Mar 2002 10:19:15 -0000 1.7
@@ -4,7 +4,7 @@
<!--
Author: dIon Gillard
- Version: $Id: developers-guide.xml,v 1.6 2002/01/30 05:42:02 dion Exp $
+ Version: $Id: developers-guide.xml,v 1.7 2002/03/29 10:19:15 dion Exp $
-->
<chapter id="users-guide">
@@ -16,25 +16,22 @@
on <ulink url="index.html">Latka</ulink>. Hopefully they will make sense to
those coming after me, and possibly clarify the current state for the existing
</para>
- <para>This should probably be set out (from the source side) more
-like a book than a chapter</para>
- <para>That said, on with the disorganised discourse</para>
</section>
<section id="coding-style">
<title>Coding Style</title>
- <para>Latka has some unusual coding conventions, which I'm trying to
-capture at the moment using a tool, <ulink
-url="http://checkstyle.sourceforge.net">CheckStyle</ulink>. Since I'm not quite
-sure what all the conventions are myself, nothing is really authoratative except
-the source code</para>
+ <para>Latka has some unusual coding conventions, which we've hopefully
+captured using a tool, <ulink url="http://checkstyle.sourceforge.net">CheckStyle
+</ulink>.</para>
<para>Onto the conventions... The Sun coding conventions are followed in
most places, except for the items that follow</para>
<itemizedlist>
<listitem><para>private and protected member variables begin with an
underscore, <programlisting>_requestSucceeded</programlisting></para></listitem>
- <listitem><para>private methods also begin with an underscore</para>
+ <listitem><para>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)</para>
</listitem>
<listitem><para>Javadoc on classes and methods is not yet complete.
Feel free to help out here :-)</para></listitem>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>