You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by jo...@apache.org on 2012/05/07 02:33:17 UTC
svn commit: r1334847 - /httpd/site/trunk/content/dev/styleguide.mdtext
Author: joes
Date: Mon May 7 00:33:17 2012
New Revision: 1334847
URL: http://svn.apache.org/viewvc?rev=1334847&view=rev
Log:
headings
Modified:
httpd/site/trunk/content/dev/styleguide.mdtext
Modified: httpd/site/trunk/content/dev/styleguide.mdtext
URL: http://svn.apache.org/viewvc/httpd/site/trunk/content/dev/styleguide.mdtext?rev=1334847&r1=1334846&r2=1334847&view=diff
==============================================================================
--- httpd/site/trunk/content/dev/styleguide.mdtext (original)
+++ httpd/site/trunk/content/dev/styleguide.mdtext Mon May 7 00:33:17 2012
@@ -68,7 +68,7 @@ of "`(char*)i`")
# Details and Examples #
-- **Indentation, General Style**
+## **Indentation, General Style**
Each level of indentation of code is four spaces. Tab characters should
never be used. Specific indentation rules for function declarations and
@@ -105,7 +105,7 @@ Example:
}
-- **Comments**
+## **Comments**
Provide comments which explain the function of code where it is not clear
from the code itself. Provide rationale where necessary for particular bits
@@ -120,7 +120,7 @@ Example:
code;
-- **Function Declaration and Layout**
+## **Function Declaration and Layout**
Functions are laid out as follows:
@@ -141,7 +141,7 @@ closing brace is indented to line up wit
section on indenting<A HREF="#long-exps">long declarations and
invocations</A>.**
-- **Function Calls**
+## **Function Calls**
Space after commas in function calls. No space between function name and
opening bracket.
@@ -153,7 +153,7 @@ Example:
**Also see the section on indenting<A HREF="#long-exps">long declarations
and invocations</A>.**
-- **Flow-Control Layout**
+## **Flow-Control Layout**
Flow-control statements
(`if`, `while`, `for`, *etc.*) are
@@ -176,7 +176,7 @@ placed on the line following the closing
with the corresponding `if`. **Also see the section on
indenting<A HREF="#long-exps">long expressions</A>.**
-- **`for` Layout**
+## **`for` Layout**
Space after the semi-colons.
@@ -185,7 +185,8 @@ Example:
for (a; b; c)
-- **`switch` Layout**
+## **`switch` Layout**
+
`case` lines within a `switch()` are indented to same
level as the switch statement itself. The code for each case is indented by
four spaces. Braces are laid out as for other control-flow keywords.
@@ -200,7 +201,7 @@ Example:
}
-- **Expressions**
+## **Expressions**
Space before and after assignment and other and operators. No space between
unary operators (increment, decrement, and negation) and the lvalue.
@@ -215,7 +216,7 @@ Examples:
++a
-- **Capitalisation of Enums**
+## **Capitalisation of Enums**
No rule.