twix/raylib
1
0
Fork 0
mirror of https://github.com/raysan5/raylib.git synced 2025-12-25 10:22:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

Created raylib coding conventions (markdown)

Ray
2017-11-17 19:17:11 +01:00
parent 32c4a5da62
commit ae3ef8be17
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
raylib-coding-conventions.md Normal file

@ -0,0 +1,21 @@
This page list some coding conventions rules I try to follow on raylib C code:
Code element | Convention | Example
--- | :---: | ---
Macros | ALL_CAPS | `#define MIN(a,b) (((a)<(b))?(a):(b))`
Defines | ALL_CAPS | `#define PLATFORM_DESKTOP`
Constants | ALL_CAPS | `const int NUMBER = 8`
Struct | TitleCase | `struct Texture2D`
Struct members |lowerCase | `texture.id`
Enum | TitleCase | `TextureFormat`
Enum members | ALL_CAPS | `UNCOMPRESSED_R8G8B8`
Functions | TitleCase or prefixTitleCase | `InitWindow()`
Variables | lowerCase | `screenWidth`
Local variables | lowerCase | `playerPosition`
Global variables | lowerCase | `fullscreen`
Operators | value1*value2 | `int product = value*6;`
Operators | value1/value2 | `int division = value/4;`
Operators | value1 + value2 | `int sum = value + 10;`
Operators | value1 - value2 | `int res = value - 5;`
Pointers | MyType *pointer | `Texture2D *array;`
float values | always x.xf | `float value = 10.0f`