thepigeongenerator/mcaselector-lite
1
0
Fork 0
mirror of https://github.com/thepigeongenerator/mcaselector-lite.git synced 2025-12-17 07:35:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

seperate out general good C practice from the style guide

Browse Source
This commit is contained in:
Quinn
2025-08-12 11:46:26 +02:00
parent 54428e72f9
commit f0e6aa38c7
2 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/dev/styleref.md
View File

@@ -11,16 +11,10 @@
- linux / unix-like machine
### style guide
- parameterless functions should have the `void` parameter.[^cstd]
- symbols mustn't be prefixed with `_`; this is a C standard reserved symbol.[^cstd]
- typedefs (or anything else for that matter) mustn't be suffixed with `_t`, this is reserved by POSIX.[^cstd]
- functions should do one thing, and do that thing well.[^cstd]
- K&R style braces/indentation[^wikiindent]
- Code must be written correctly, read [Correct C](./correct-c.md) if more information is required.
- K&R style braces/[indentation](https://en.wikipedia.org/wiki/Indentation_style)
- typedefs are discouraged
- snake_case is used for all user-defined symbols. Macros are often all-uppercase, same goes for enums and other types of compile-time constants.
- tabs are used for indentation, spaces are used for alignment.
- British spelling is preferred, but not enforced. What is enforced is that British variants of the symbols are available.
- commits should attempt to convey clearly what is being changed, for the sanity of the maintainer(s).
[cstd]: this is a general C practice, included since it is something commonly done incorrectly.
[wikiindent]: <https://en.wikipedia.org/wiki/Indentation_style>