diff options
author | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2004-12-11 19:32:55 +0000 |
---|---|---|
committer | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2004-12-11 19:32:55 +0000 |
commit | 05d33ff0f45fce64889b18bc95818fe1610839ad (patch) | |
tree | 4da3360e8c9724b87243d44a54478ec95c973606 /docs | |
parent | b6aca4910aa14cdc7bfe5de07baf3d0548e8ae6f (diff) | |
download | mana-05d33ff0f45fce64889b18bc95818fe1610839ad.tar.gz mana-05d33ff0f45fce64889b18bc95818fe1610839ad.tar.bz2 mana-05d33ff0f45fce64889b18bc95818fe1610839ad.tar.xz mana-05d33ff0f45fce64889b18bc95818fe1610839ad.zip |
Added HACKING.txt and reverted the revertion of my changes to log.cpp ;)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/HACKING.txt | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/HACKING.txt b/docs/HACKING.txt new file mode 100644 index 00000000..ba080f0f --- /dev/null +++ b/docs/HACKING.txt @@ -0,0 +1,36 @@ +---------------------------- +The Mana World Hacking Guide +---------------------------- + +With multiple coders working on the same source files, there needs to be a +standard specifying how code is written down. Not doing so can cause quite some +annoyance for certain coders and easily creates more version conflicts than +necessary. + +* Code is indented using 4 spaces, no tabs. + +* Control constructs like this: + + if (condition) { + } + + for (init; condition; step) { + } + + while (condition) { + } + + /* + * Documentation about behaviour + */ + void function(param1, param2) { + } + + Ending parenthesis may be on next line for clarity. + +* Use of whitespace example: + + x = ((5 + 4) * 3) / 1.5; + +* Agreement on function/class/variable/method/member naming pending. + |