diff options
Diffstat (limited to 'docs/CodingStandards.html')
| -rw-r--r-- | docs/CodingStandards.html | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 4af3c6a5bf..7791e8dd87 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -824,10 +824,12 @@ known.</p> should be in camel case (e.g. <tt>TextFileReader</tt> and <tt>isLValue()</tt>). Type names (including classes, structs, enums, typedefs, etc) should be nouns and start with an upper-case -letter (e.g. <tt>TextFileReader</tt>). Function names should be verb -phrases (as they represent actions) and start with a lower-case letter -(e.g. a predicate may be named <tt>isFoo()</tt> or <tt>hasBar()</tt>, -while the name of a command-like function should be imperative, +letter (e.g. <tt>TextFileReader</tt>). An <tt>enum</tt> for all the +different kinds of something should be named with the <tt>Kind</tt> +suffix. Function names should be verb phrases (as they represent +actions) and start with a lower-case letter (e.g. a predicate may be +named <tt>isFoo()</tt> or <tt>hasBar()</tt>, while the name of a +command-like function should be imperative, like <tt>openFile()</tt>).</p> <p>Enumerators and public member variables should start with an |