ace-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1242173 - /ace/site/trunk/content/dev-doc/coding-standards.mdtext
Date Wed, 08 Feb 2012 23:30:48 GMT
Author: marrs
Date: Wed Feb  8 23:30:48 2012
New Revision: 1242173

URL: http://svn.apache.org/viewvc?rev=1242173&view=rev
Log:
Test formatting

Modified:
    ace/site/trunk/content/dev-doc/coding-standards.mdtext

Modified: ace/site/trunk/content/dev-doc/coding-standards.mdtext
URL: http://svn.apache.org/viewvc/ace/site/trunk/content/dev-doc/coding-standards.mdtext?rev=1242173&r1=1242172&r2=1242173&view=diff
==============================================================================
--- ace/site/trunk/content/dev-doc/coding-standards.mdtext (original)
+++ ace/site/trunk/content/dev-doc/coding-standards.mdtext Wed Feb  8 23:30:48 2012
@@ -170,7 +170,7 @@ Tag                  | Short description
 `<ul><li></li></ul>` | Unordered list of items. Each item should
start with a <li> tag. Most browsers format this as a bullet list.
 `<code></code>`      | Code samples. Use this when refering to class names, method
names, parameter names, etc.
 
-{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}
+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.
 
 Example:
 
@@ -377,17 +377,12 @@ Blank lines improve readability by setti
 Blank spaces should be used in the following circumstances:
 
 - A keyword followed by a parenthesis should be separated by a space.
-
-    while (index > 5) {
+    `while (index > 5) {
         // ...
-    }
-
-Note that blanks should not be used between a method call and its opening parenthesis. This
helps to distinguish keywords from function calls.
-
+    }`
+    Note that blanks should not be used between a method call and its opening parenthesis.
This helps to distinguish keywords from function calls.
 - Blanks should appear after commas in argument lists.
-
 - 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;



Mime
View raw message