diff options
| author | Chris Lattner <sabre@nondot.org> | 2011-08-12 19:49:16 +0000 |
|---|---|---|
| committer | Chris Lattner <sabre@nondot.org> | 2011-08-12 19:49:16 +0000 |
| commit | c513309224611d662a8de51f81216164f5954a30 (patch) | |
| tree | d8efab94c6b7c87c97e0636497db830715ebbdbd /docs | |
| parent | 9a5ffbfa6eb2234b9d7bdde0360200823a74130e (diff) | |
| download | llvm-c513309224611d662a8de51f81216164f5954a30.tar.gz llvm-c513309224611d662a8de51f81216164f5954a30.tar.bz2 llvm-c513309224611d662a8de51f81216164f5954a30.tar.xz | |
apparently variable naming conventions never got added, document the
prevailing convention. Thanks to Dave Zarzycki for the patch.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@137497 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CodingStandards.html | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 7f92b9a7cf..a96f760e67 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -854,8 +854,12 @@ rules:</p> <ul> <li><p><b>Type names</b> (including classes, structs, enums, typedefs, etc) - should be nouns and start with an upper-case letter (e.g. - <tt>TextFileReader</tt>).</p></li> + should be nouns and start with an upper-case letter (e.g. + <tt>TextFileReader</tt>).</p></li> + +<li><p><b>Variable names</b> should be nouns (as they represent state). The + name should be camel case, and start with an upper case letter (e.g. + <tt>Leader</tt> or <tt>Boats</tt>).</p></li> <li><p><b>Function names</b> should be verb phrases (as they represent actions), and command-like function should be imperative. The name should |