diff options
author | Nikolay Korolev <nickvnuk@gmail.com> | 2020-10-11 11:58:11 +0200 |
---|---|---|
committer | Nikolay Korolev <nickvnuk@gmail.com> | 2020-10-11 11:58:11 +0200 |
commit | 552f308e9e0a745852ca11064b6b31e16b115917 (patch) | |
tree | a88d109962a7de5594f3781fe1e388879936218c /CODING_STYLE.md | |
parent | Control updates (diff) | |
parent | Merge pull request #760 from Sergeanur/VC/TextFinish (diff) | |
download | re3-552f308e9e0a745852ca11064b6b31e16b115917.tar re3-552f308e9e0a745852ca11064b6b31e16b115917.tar.gz re3-552f308e9e0a745852ca11064b6b31e16b115917.tar.bz2 re3-552f308e9e0a745852ca11064b6b31e16b115917.tar.lz re3-552f308e9e0a745852ca11064b6b31e16b115917.tar.xz re3-552f308e9e0a745852ca11064b6b31e16b115917.tar.zst re3-552f308e9e0a745852ca11064b6b31e16b115917.zip |
Diffstat (limited to 'CODING_STYLE.md')
-rw-r--r-- | CODING_STYLE.md | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/CODING_STYLE.md b/CODING_STYLE.md new file mode 100644 index 00000000..b8be02bc --- /dev/null +++ b/CODING_STYLE.md @@ -0,0 +1,107 @@ +# Coding style + +I started writing in [Plan 9 style](http://man.cat-v.org/plan_9/6/style), +but realize that this is not the most popular style, so I'm willing to compromise. +Try not to deviate too much so the code will look similar across the whole project. + +To give examples, these two styles (or anything in between) are fine: + +``` +type +functionname(args) +{ + if(a == b){ + s1; + s2; + }else{ + s3; + s4; + } + if(x != y) + s5; +} + +type functionname(args) +{ + if (a == b) { + s1; + s2; + } else { + s3; + s4; + } + if (x != y) + s5; +} +``` + +This one (or anything more extreme) is heavily discouraged: + +``` +type functionname ( args ) +{ + if ( a == b ) + { + s1; + s2; + } + else + { + s3; + s4; + } + if ( x != y ) + { + s5; + } +} +``` + +i.e. + +* Put the brace on the same line as control statements + +* Put the brace on the next line after function definitions and structs/classes + +* Put an `else` on the same line with the braces + +* Don't put braces around single statements + +* Put the function return type on a separate line + +* Indent with TABS + +As for the less cosmetic choices, here are some guidelines how the code should look: + +* Don't use magic numbers where the original source code would have had an enum or similar. +Even if you don't know the exact meaning it's better to call something `FOOBAR_TYPE_4` than just `4`, +since `4` will be used in other places and you can't easily see where else the enum value is used. + +* Don't just copy paste code from IDA, make it look nice + +* Use the right types. In particular: + + * don't use types like `__int16`, we have `int16` for that + + * don't use `unsigned`, we have typedefs for that + + * don't use `char` for anything but actual characters, use `int8`, `uint8` or `bool` + + * don't even think about using win32 types (`BYTE`, `WORD`, &c.) unless you're writing win32 specific code + + * declare pointers like `int *ptr;`, not `int* ptr;` + +* As for variable names, the original gta source code was not written in a uniform style, +but here are some observations: + + * many variables employ a form of hungarian notation, i.e.: + + * `m_` may be used for class member variables (mostly those that are considered private) + + * `ms_` for (mostly private) static members + + * `f` is a float, `i` or `n` is an integer, `b` is a boolean, `a` is an array + + * do *not* use `dw` for `DWORD` or so, we're not programming win32 + +* Generally, try to make the code look as if R* could have written it |