djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CODECONVENTIONS.md: add documentation on putting comments in code.

Browse Source
This commit is contained in:
Garrett Berg 2015-06-12 20:49:01 -06:00 committed by Damien George
parent e44c1d3ace
commit f64e080d9a
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CODECONVENTIONS.md
View File

@ -52,13 +52,19 @@ general guidelines are:
- You can use int/uint, but remember that they may be 16-bits wide. - You can use int/uint, but remember that they may be 16-bits wide.
- If in doubt, use mp_int_t/mp_uint_t. - If in doubt, use mp_int_t/mp_uint_t.
Comments:
- Be concise and only write comments for things that are not obvious.
- Use `// ` prefix, NOT `/* ... */`. No extra fluff.
Examples Examples
-------- --------
Braces, spaces and names: Braces, spaces, names and comments:
#define TO_ADD (123) #define TO_ADD (123)
// This function will always recurse indefinitely and is only used to show
// coding style
int foo_function(int x, int some_value) { int foo_function(int x, int some_value) {
if (x < some_value) { if (x < some_value) {
foo(some_value, x); foo(some_value, x);