diff options
Diffstat (limited to 'style.md')
| -rw-r--r-- | style.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/style.md b/style.md new file mode 100644 index 0000000..b81ba82 --- /dev/null +++ b/style.md @@ -0,0 +1,45 @@ +# code style + +this is a quick run-down of basic code style guidelines. code is expected to be +formatted when a pull request is submitted. + +## general rules + +### style + +all of these can automatically be corrected using `make format` + +- indent using tab +- tab display width (should) be equal to 2 spaces +- symbols in snake case +- file names in snake case +- c++ classes are in CamelCase +- open brackets on same line + +### naming + +most (but not all) naming convention errors can be corrected using `make +format` too, but might cause incompatibility issues. make sure to commit code +before formatting as a failsafe. + +- prefix symbols with `hh_` (e.g. `hh_game_loop_main`) +- prefix global variables with `g_hh_` (e.g. `g_hh_example_global_variable`) +- global constants are uppercase snake (e.g. `HH_SERIAL_BAUD`) +- enum typedefs are prefixed with `hh_e_` (e.g. `hh_e_entity_state`) +- struct typedefs are prefixed with `hh_s_` (e.g. `hh_s_bam_tile`) +- custom typedefs are prefixed with `hh_` and suffixed with `_t` (e.g. `hh_bam_tile_t`) +- library hooks that need specific symbol names are exempt from the naming + conventions (e.g. `main` or `HAL_UART_MspInit`) + +### others + +- document **how to use** code using doxygen-style comments in headers +- document **what code is doing** using inline comments (where applicable) +- don't write redundant comments (e.g. `int c = a + b; // add a and b`) + +## markdown + +### style + +- indent using spaces, align to text start + |