aboutsummaryrefslogtreecommitdiff
path: root/doc/coding.txt
diff options
context:
space:
mode:
authorJaromil <jaromil@dyne.org>2011-04-23 11:49:47 +0200
committerJaromil <jaromil@dyne.org>2011-04-23 12:10:25 +0200
commit84c3fb07b0b8199c7f85c5de280e7100bad0786f (patch)
treec259ad219b95fb3d55c685062f2ba226ec0dafe7 /doc/coding.txt
parent64ad448adc67f3c32fe0dfe074c82a8377f67ee7 (diff)
directory re-organization (keeps the old build system)
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
Diffstat (limited to 'doc/coding.txt')
-rw-r--r--doc/coding.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/coding.txt b/doc/coding.txt
new file mode 100644
index 0000000000..4707476697
--- /dev/null
+++ b/doc/coding.txt
@@ -0,0 +1,41 @@
+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