Browse Source

update coding.md to reflect changes by pull

- also mention alphabetical include ordering
0.10
Philip Kaufmann 10 years ago
parent
commit
86fe1b864b
  1. 75
      doc/coding.md

75
doc/coding.md

@ -4,44 +4,65 @@ Coding
Please be consistent with the existing coding style. Please be consistent with the existing coding style.
Block style: Block style:
```c++
bool Function(char* psz, int n) bool Function(char* psz, int n)
{ {
// Comment summarising what this section of code does // Comment summarising what this section of code does
for (int i = 0; i < n; i++) for (int i = 0; i < n; i++)
{ {
// When something fails, return early // When something fails, return early
if (!Something()) if (!Something())
return false; return false;
... ...
} }
// Success return is usually at the end // Success return is usually at the end
return true; return true;
} }
```
- ANSI/Allman block style - ANSI/Allman block style
- 4 space indenting, no tabs - 4 space indenting, no tabs
- No extra spaces inside parenthesis; please don't do ( this ) - No extra spaces inside parenthesis; please don't do ( this )
- No space after function names, one space after if, for and while - No space after function names, one space after if, for and while
- Includes need to be ordered alphabetically, separate own and foreign headers with a new-line (example key.cpp):
```c++
#include "key.h"
#include "crypto/sha2.h"
#include "util.h"
#include <openssl/foo.h>
```
- Class or struct keywords in header files need to be ordered alphabetically:
```c++
class CAlpha;
class CBeta;
```
- When using namespace keyword use the following form:
```c++
namespace Foo {
...
} // Foo
```
Variable names begin with the type in lowercase, like nSomeVariable. Variable names begin with the type in lowercase, like nSomeVariable.
Please don't put the first word of the variable name in lowercase like Please don't put the first word of the variable name in lowercase like
someVariable. someVariable.
Common types: Common types:
n integer number: short, unsigned short, int, unsigned int, int64, uint64, sometimes char if used as a number n integer number: short, unsigned short, int, unsigned int, int64, uint64, sometimes char if used as a number
d double, float d double, float
f flag f flag
hash uint256 hash uint256
p pointer or array, one p for each level of indirection p pointer or array, one p for each level of indirection
psz pointer to null terminated string psz pointer to null terminated string
str string object str string object
v vector or similar list objects v vector or similar list objects
map map or multimap map map or multimap
set set or multiset set set or multiset
bn CBigNum bn CBigNum
Doxygen comments Doxygen comments
----------------- -----------------

Loading…
Cancel
Save