mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-10-17 02:45:05 +00:00
89f1804184
- Implemented async keyboard API. Made it backwards compatible. - `KeyboardApi::read_key` and `keyboard_read_key()` automatically forward to subscribing pollers. - Implement `Device::probe` for device hot-plug support. - Implement probing for Tab5 keyboard - Updated coding style guide
21 lines
1.1 KiB
Markdown
21 lines
1.1 KiB
Markdown
# Coding Style
|
|
|
|
Two conventions coexist; which one to use depends on the project layer:
|
|
|
|
- **C code**: `lower_snake_case` for files, functions, variables. `UpperCamelCase` for types. Files in `source/`, `include/`, `private/` directories.
|
|
- **C++ code**: `UpperCamelCase` for files and types. `lowerCamelCase` for functions. Files in `Source/`, `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.
|