mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-10-17 02:45:05 +00:00
1.1 KiB
1.1 KiB
Coding Style
Two conventions coexist; which one to use depends on the project layer:
- C code:
lower_snake_casefor files, functions, variables.UpperCamelCasefor types. Files insource/,include/,private/directories. - C++ code:
UpperCamelCasefor files and types.lowerCamelCasefor functions. Files inSource/,Include/,Private/directories.
For projects that emit C headers and have a C++ implementation file: the internal C++ function naming should be snake_case.
Formatting is enforced by .clang-format (LLVM-based, 4-space indent, no column limit).
Never throw exceptions — use return types for error handling. Use enum class over plain enum when writing C++ code.
Do not add redundant null checks for parameters with an explicit non-null precondition.
Code Comments (important!):
- Should be minimal, but must contain critical information.
- Must not explain how code was before, or how it was changed.
- Should avoid explaining what was not implemented.
- Must avoid referring to designs of other subsystems.
- Must avoid interjections: avoid hyphens or braces to interject.