-
-
Notifications
You must be signed in to change notification settings - Fork 17
Code Style
Quintin edited this page Jun 14, 2022
·
14 revisions
- Use clang-format before committing. Read this for VSCode and for CLion it should work automatically by detecting the
.clang-format
file. -
Never use raw pointers, prefer
std::shared_ptr
etc. - Check if something exists in the standard library before you reinvent the wheel!
- Prefer
static_cast
etc. instead of C style cast - Use
auto
on iterator types (ranged for) and when the type is obvious, for example casting orstd::make_shared
- Do not use references (&) types for out parameters in functions, prefer returning a struct
- Prefer using an explicit struct instead of
std::pair
orstd::tuple
- Currently
pycodestyle
,flake8
, andisort
are used as a basic check. Read this for VSCode, ideally you adhere topylint
too but it can be very strict so right now it wont be enforced. - If you are writing a function, please use type hinting for the signature. For other places, only use if necessary, for example a situation where the types are confusing.