tulpenkiste/hibiscus
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Fix lists in CODINGSTYLE.md

Browse source
This commit is contained in:
Tulpen 2023-06-01 13:00:32 +01:00
parent 8293e6cf4f
commit 76e38a87e2
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CODINGSTYLE.md
View file

@ -5,6 +5,7 @@ Use C++17 as the C++ standard. Hibis should compile under all major compilers.
Each module of the game engine should be kept within their specific folders. E.g.: Each module of the game engine should be kept within their specific folders. E.g.:
- Core - Core
- Renderer/(renderer name) - Renderer/(renderer name)
<!-- -->
If statically linking third party libraries are *absolutely* required, they must be placed in a folder called `external` in the repository root. If statically linking third party libraries are *absolutely* required, they must be placed in a folder called `external` in the repository root.
## Formatting ## Formatting
Files need to end with a new line.<br> Files need to end with a new line.<br>
@ -29,6 +30,7 @@ Variables should be prefixed with specific chars depending on where the variable
- Member Variable - Prefix with `m` - Member Variable - Prefix with `m`
- Global Variable - Prefix with `g` - Global Variable - Prefix with `g`
- Static Variable - Prefix with `s` - Static Variable - Prefix with `s`
<!-- -->
Example: Example:
```cpp ```cpp
const int gAmountOfTimesISuccessfullyWriteGoodVariableNames = 0; const int gAmountOfTimesISuccessfullyWriteGoodVariableNames = 0;