-
-
Notifications
You must be signed in to change notification settings - Fork 150
Coding guidelines
Paweł Kotiuk edited this page Aug 18, 2021
·
7 revisions
Code documentation should be written using doxygen syntax.
It is recommended to document non-trivial methods, bigger classes (their purpose in two-three sentences) and some hacky
solutions in code.
Class comments go in front of classes, method comments in front of method definitions in cpp files link for curious.
Style of names:
- ClassNames -
UpperCamelCase
- functionNames -
camelCase
- variable_names -
underscore_style
- m_class_members -
m_underscore_with_m_letter_at_the_beginning
(I know these are not respected in many pieces of antimicrox code, but it would be good to at least to try to stick to them in newer parts)
Other aspects of formatting are handled by clang-format
Every direct commit to master should describe type of commit (check https://www.conventionalcommits.org/en/v1.0.0/ for more details)
Used types of commits: fix:
, feat:
, build:
, chore:
, ci:
, docs:
, style:
, refactor:
, perf:
, test: