varl/qmk_firmware
1
0
Fork 0
forked from forks/qmk_firmware
Code Pull requests Activity

[Docs] Code markdown amendment (#21323)

Browse source
This commit is contained in:
Albert Y 2023-06-21 10:58:13 +08:00 committed by GitHub
parent 7753249d3d
commit 2f1cac6e9f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/coding_conventions_c.md
View file

@ -8,8 +8,8 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely
* Closing Brace: Lined up with the first character of the statement that opens the block * Closing Brace: Lined up with the first character of the statement that opens the block
* Else If: Place the closing brace at the beginning of the line and the next opening brace at the end of the same line. * Else If: Place the closing brace at the beginning of the line and the next opening brace at the end of the same line.
* Optional Braces: Always include optional braces. * Optional Braces: Always include optional braces.
* Good: if (condition) { return false; } * Good: `if (condition) { return false; }`
* Bad: if (condition) return false; * Bad: `if (condition) return false;`
* We encourage use of C style comments: `/* */` * We encourage use of C style comments: `/* */`
* Think of them as a story describing the feature * Think of them as a story describing the feature
* Use them liberally to explain why particular decisions were made. * Use them liberally to explain why particular decisions were made.