84c3fb07b0
there is no internal modification of any file in this commit
files are moved into directories according to established standards in
sourcecode distribution; these directories contain:
src - Files that are used in constructing the executable binaries,
but are not installed.
doc - Files in HTML and text format that document usage, quirks of
the implementation, and contributor checklists.
locale - Files that contain human language translation of strings
used in the program
contrib - Files contributed from distributions or other third party
implementing scripts and auxiliary programs
41 lines
1.2 KiB
Text
41 lines
1.2 KiB
Text
Please be consistent with the existing coding style.
|
|
|
|
Block style:
|
|
|
|
bool Function(char* psz, int n)
|
|
{
|
|
// Comment summarising what this section of code does
|
|
for (int i = 0; i < n; i++)
|
|
{
|
|
// When something fails, return early
|
|
if (!Something())
|
|
return false;
|
|
...
|
|
}
|
|
|
|
// Success return is usually at the end
|
|
return true;
|
|
}
|
|
|
|
- ANSI/Allman block style
|
|
- 4 space indenting, no tabs
|
|
- No extra spaces inside parenthesis; please don't do ( this )
|
|
- No space after function names, one space after if, for and while
|
|
|
|
Variable names begin with the type in lowercase, like nSomeVariable.
|
|
Please don't put the first word of the variable name in lowercase like
|
|
someVariable.
|
|
|
|
Common types:
|
|
n integer number: short, unsigned short, int, unsigned int,
|
|
int64, uint64, sometimes char if used as a number
|
|
d double, float
|
|
f flag
|
|
hash uint256
|
|
p pointer or array, one p for each level of indirection
|
|
psz pointer to null terminated string
|
|
str string object
|
|
v vector or similar list objects
|
|
map map or multimap
|
|
set set or multiset
|
|
bn CBigNum
|