You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by dl...@apache.org on 2001/09/16 21:27:14 UTC
cvs commit: jakarta-turbine-site/xdocs/common code-standards.xml
dlr 01/09/16 12:27:14
Modified: xdocs/common code-standards.xml
Log:
Reworded a couple of paragraphs and added some formatting.
Revision Changes Path
1.2 +15 -13 jakarta-turbine-site/xdocs/common/code-standards.xml
Index: code-standards.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-site/xdocs/common/code-standards.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -u -r1.1 -r1.2
--- code-standards.xml 2001/08/01 18:55:57 1.1
+++ code-standards.xml 2001/09/16 19:27:14 1.2
@@ -64,9 +64,8 @@
]]></source>
<p>
-2. It is <strong>OK</strong> to have spaces between the parens or not. The
-preference is to not include the extra spaces. For example, both of these are
-ok:
+2. Though it's considered okay to include spaces inside parens, the
+preference is to not include them. Both of the following are okay:
</p>
<source test=""><![CDATA[
@@ -78,17 +77,20 @@
]]></source>
<p>
-3. 4 spaces. <strong>NO</strong> tabs. Period. We understand that a lot of you
-like to use tabs, but the fact of the matter is that in a distributed
-development enviroment, when the cvs commit messages get sent to a mailing list,
-they are almost impossible to read if you use tabs.
+3. 4 space indent. <strong>NO tabs</strong>. Period. We understand
+that many developers like to use tabs, but the fact of the matter is
+that in a distributed development environment where diffs are sent to
+the mailing lists by both developers and the version control system
+(which sends commit log messages), the use tabs makes it impossible to
+preserve legibility.
</p>
<p>
In Emacs-speak, this translates to the following command:
+<source><![CDATA[
(setq-default tab-width 4 indent-tabs-mode nil)
-
+]]></source>
</p>
<p>
@@ -97,10 +99,10 @@
</p>
<p>
-5. Javadoc <strong>MUST</strong> exist on all your methods. Also, if you are
-working on existing code and there currently isn't a javadoc for that
-method/class/variable or whatever, then you should contribute and add it.
-This will improve the project as a whole.
+5. JavaDoc <strong>MUST</strong> exist on all methods. If your code
+modifications use an existing class/method/variable which lacks
+JavaDoc, it is required that you add it. This will improve the
+project as a whole.
</p>
<p>
@@ -123,7 +125,7 @@
</p>
<source><![CDATA[
-@version $Id: code-standards.xml,v 1.1 2001/08/01 18:55:57 mpoeschl Exp $
+@version $Id: code-standards.xml,v 1.2 2001/09/16 19:27:14 dlr Exp $
]]></source>
<p>
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org