1
0
Fork 0

Recommended C style and coding rules

This commit is contained in:
Janez 2021-08-30 07:28:20 +02:00
parent ece65978d3
commit a5fb680c6c
2 changed files with 6 additions and 7 deletions

View file

@ -65,8 +65,7 @@ Report issues on https://github.com/CANopenNode/CANopenNode/issues
Older discussion group is on Sourceforge: http://sourceforge.net/p/canopennode/discussion/387151/
Contributions are welcome. Best way to contribute your code is to fork a project, modify it and then send a pull request. Some basic formatting
rules should be followed: Linux style with indentation of 4 spaces. There is also a `codingStyle` file with example and a configuration file for `clang-format` tool.
Contributions are welcome. Best way to contribute your code is to fork a project, modify it and then send a pull request. Please follow the [Recommended C style and coding rules](https://github.com/MaJerle/c-code-style), like indentation of 4 spaces, etc. There is also a `codingStyle` file with example.
CANopenNode flowchart

View file

@ -35,11 +35,11 @@ extern "C" {
* body at the end.
*
* ###Style
* - Style is based on Linux style
* - Indent size is 4.
* - Spaces are used, not tabs.
* - More datails are defined in .clang-format file
* - Some (old) code is still not corectly formatted. (To not break git history.)
* - Style is based on https://github.com/MaJerle/c-code-style
* - Indent size is 4 spaces, no tabs.
* - Line width is 80 characters.
* - Some (old) code may not be formatted according to the rules. Try to avoid
* unnecessary changes based on individual taste.
*
* ###Doxygen
* Documentation is generated by doxygen.