-
Notifications
You must be signed in to change notification settings - Fork 28
Coding Style
Man-Long (Norman) Wong edited this page Oct 22, 2022
·
3 revisions
We use C++ with the C++11 standard as the programming language for the code.
It is recommended to use:
-
UpperCamelCase
for class names -
lowerCamelCase
for methods and functions -
CAPITALIZED_WITH_UNDERSCORES
for constants -
lowercase_separated_by_underscores
for variable names -
UpperCamelCase
for file names -
lowercase_separated_by_underscores
for folder names
4 spaces of indentation, and no tab characters should be used.
A single line above the code is recommended. Add full stop at the end of each comment.
- User Guide
- Programmer Guide
- Tutorials