Updated Coding style (markdown)

master
Martin Polanka 9 years ago
parent 86afb503b8
commit f495df0535

@ -4,20 +4,20 @@ Every project should have some consistent coding style in which all contributors
## C++ ## C++
In C++ is written worker and queue manager. Generally its used underscore style with all small letters. Inspired by [Google C++ style guide](https://google.github.io/styleguide/cppguide.html) In C++ is written worker and queue manager. Generally its used underscore style with all small letters. Inspired by [Google C++ style guide](https://google.github.io/styleguide/cppguide.html). If something is not defined than naming/formatting can be arbitrary, but should be similar to bellow-defined behaviour.
### Naming convention ### Naming convention
* For source codes use all lower case with underscores not dashes. Header files should end with `.h` and C++ files with `.cpp`. * For source codes use all lower case with underscores not dashes. Header files should end with `.h` and C++ files with `.cpp`.
* Typenames are all in lower case with underscores between words. This is applicable to classes, structs, typedefs, enums and type template parameters. * Typenames are all in lower case with underscores between words. This is applicable to classes, structs, typedefs, enums and type template parameters.
* Variable names can be divided on local variables and class members. Local variables are all lower case with underscores between words. Class members have in addition trailing underscore on the end (struct data members do not have underscore on the end). * Variable names can be divided on local variables and class members. Local variables are all lower case with underscores between words. Class members have in addition trailing underscore on the end (struct data members do not have underscore on the end).
* Constants? * Constants are just like any other variables and do not have any specifics.
* All function names are again all lower case with underscores between words. * All function names are again all lower case with underscores between words.
* Namespaces if there are ones they should have lower case and underscores. * Namespaces if there are ones they should have lower case and underscores.
* Macros are classical and should have all capitals and underscores. * Macros are classical and should have all capitals and underscores.
* Comments can be two types documentational and ordinery ones in code. Documentation should start with `/**` and end with `*/`, convention between this is javadoc documentation format. Classical comments in code starts with `?` and end with `?`. (NOT DECIDED YET) * Comments can be two types documentational and ordinery ones in code. Documentation should start with `/**` and end with `*/`, convention inside them is javadoc documentation format. Classical comments in code are one liners which starts with `//` and end with the end of the line.
### Formatting convention ### Formatting convention
* Line length 80 characters. (NOT DECIDED YET) * Line length is not explicitly defined, but should be reasonable.
* All files should use UTF-8 character set. * All files should use UTF-8 character set.
* For code indentation tabs (`\t`) are used. * For code indentation tabs (`\t`) are used.
* Function declaration/definition: return type should be on the same line as the rest of the declaration, if line is too long, than particular parameters are placed on new line. Opening parenthesis of function should be placed on new line bellow declaration. Its possible to write small function which can be on only one line. Between parameter and comma should be one space. * Function declaration/definition: return type should be on the same line as the rest of the declaration, if line is too long, than particular parameters are placed on new line. Opening parenthesis of function should be placed on new line bellow declaration. Its possible to write small function which can be on only one line. Between parameter and comma should be one space.

Loading…
Cancel
Save