Author: buildbot
Date: Wed Feb 8 23:30:53 2012
New Revision: 804290
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/dev-doc/coding-standards.html
Modified: websites/staging/ace/trunk/content/dev-doc/coding-standards.html
==============================================================================
--- websites/staging/ace/trunk/content/dev-doc/coding-standards.html (original)
+++ websites/staging/ace/trunk/content/dev-doc/coding-standards.html Wed Feb 8 23:30:53 2012
@@ -309,7 +309,7 @@
</tr>
</tbody>
</table>
-<p>{note}There is no need to embed the parameter name in the @param tag in <code>
tags; this is done by JavaDoc automatically. The same holds for the exception name in the
@exception or @throws tag. In the clarifying text however, use the <code> tags when
refering to parameter names etc. The example below shows the <code> tag being used for
the array parameter in the text, but not in its definition.{note}</p>
+<p>There is no need to embed the parameter name in the @param tag in <code><code></code>
tags; this is done by JavaDoc automatically. The same holds for the exception name in the
@exception or @throws tag. In the clarifying text however, use the <code><code></code>
tags when refering to parameter names etc. The example below shows the <code><code></code>
tag being used for the array parameter in the text, but not in its definition.</p>
<p>Example:</p>
<div class="codehilite"><pre>/**
* Prints a range from an object array. The range
@@ -498,24 +498,18 @@ public void printRange(List<span class="
<h4 id="blank_spaces">Blank spaces</h4>
<p>Blank spaces should be used in the following circumstances:</p>
<ul>
+<li>A keyword followed by a parenthesis should be separated by a space.
+ <code>while (index > 5) {
+ // ...
+ }</code>
+ Note that blanks should not be used between a method call and its opening parenthesis.
This helps to distinguish keywords from function calls.</li>
+<li>Blanks should appear after commas in argument lists.</li>
<li>
-<p>A keyword followed by a parenthesis should be separated by a space.</p>
-<p>while (index > 5) {
- // ...
-}</p>
-</li>
-</ul>
-<p>Note that blanks should not be used between a method call and its opening parenthesis.
This helps to distinguish keywords from function calls.</p>
-<ul>
-<li>
-<p>Blanks should appear after commas in argument lists.</p>
-</li>
-<li>
-<p>All binary and ternary operators except "." should be separated from their operands
by spaces. Blanks should never separate unary operators such as unary minus, increment("++")
and decrement("--") from their operands.</p>
-<p>a += c + d;
-a = (a + b) / (c * d);
-a = (b > c) ? b : c;
-xCoord--;</p>
+<p>All binary and ternary operators except "." should be separated from their operands
by spaces. Blanks should never separate unary operators such as unary minus, increment("++")
and decrement("--") from their operands.
+ a += c + d;
+ a = (a + b) / (c * d);
+ a = (b > c) ? b : c;
+ xCoord--;</p>
</li>
<li>
<p>The expressions in a for statement should be separated by blanks.</p>
|