diff options
Diffstat (limited to 'devel')
| -rw-r--r-- | devel/STYLE.rst | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/devel/STYLE.rst b/devel/STYLE.rst index 7f27f60..1b35ae5 100644 --- a/devel/STYLE.rst +++ b/devel/STYLE.rst @@ -57,9 +57,8 @@ Indentation Tab stops MUST be 4 spaces. Hard tabs MUST NOT be used. Parenthetical statements that span multiple lines MUST have their continuation -aligned after the parenthetical. For example: +aligned after the parenthetical. For example:: -:: if(this->function() == "Fox" && that->function() != "Vulpes") @@ -71,9 +70,8 @@ Opening curly braces MUST be on the same line as the last line of the statement that they open. Closing curly braces MUST be on a separate line. Closing curly braces MUST be indented at the same level as the statement they -are closing. For example: +are closing. For example:: -:: if(foo) { bar(); } @@ -85,9 +83,8 @@ Commenting Comments MUST be written in complete, concise English sentences. Blocks of code that are directly traceable to a requirement SHOULD have a REQ -comment, such as: +comment naming the requirement the code block implements, such as:: -:: /* REQ: Runner.Validate.foo */ valid = foo->validate(); ... |