-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,8 @@ | ||
Code style | ||
---------- | ||
|
||
1. Please use ``fixed integers``, see `stdint.h`_. Why? This library is compatible to different boards which use different architectures (16bit vs 32bit). So unfixed ``int`` has different sizes on different environments and may cause unpredictable behaviour. | ||
1. Please use `fixed integers`, see `stdint.h`_. Why? This library is compatible to different boards which use different architectures (8bit vs 32bit). So unfixed `int` has different sizes on different environments and may cause unpredictable behaviour. | ||
|
||
2. If possible: use advantages of `c++11`, e.g. `constexpr`. | ||
|
||
3. Use tab in source files. Space in examples. | ||
|
||
4. Add documentation to **every** new function or parameter. Add documentation to most steps in your source code. | ||
3. Add documentation to **every** new function or parameter. Add documentation to most steps in your source code. |