[GB-202] Decide code conventions for our projects

[BramTeurlings]

Decide code conventions for our projects.

For this ticket create a small style guide document specifying rules for:

• naming of code files
• Classes
• Members
• Functions
  • Function parameters
• Scoped variables
• Globals
• Scope blocks for:
  • branches and loops (should have similar rules)
  • switch case
  • scope brackets
• Structs
• namespaces
  • namespaces in headers and implementation files
• included headers
• Constants
• Templates and macros (Prevent creating macros)

A good point to start might be the Google C++ style guide: https://google.github.io/styleguide/cppguide.html

Epic Games style guide can also be considered https://docs.unrealengine.com/5.2/en-US/epic-cplusplus-coding-standard-for-unreal-engine/

C++ Core guidelines https://isocpp.org/wiki/faq/coding-standards#coding-std-wars

Others?

Todo:

• Describe conventions on the repos

---

Originally reported by , imported from: Decide code conventions for our projects

• assignee:
• status: Done
• priority: Medium
• resolution: Complete
• resolved: 2024-02-09T06:28:48-08:00
• imported: 2024-04-04

[BramTeurlings]

712020:c26664a4-c3de-4473-a0b4-5a76804d5628:

Code conventions WIP doc: https://docs.google.com/document/d/1mYjsWdWhKdVjgc639hNoqFpKtnVTbTRmOcpre0uQEb8/edit?usp=sharing

[BramTeurlings]

712020:c26664a4-c3de-4473-a0b4-5a76804d5628:

Please have a look together with me Joey so we can discuss what's inside.

[BramTeurlings]

712020:f91dd24e-5296-4a9d-90d9-b287c639e252:

We should test whether having standard library and system header includes under project file includes causes compilation errors.

[BramTeurlings]

712020:f91dd24e-5296-4a9d-90d9-b287c639e252:

Looks good

[BramTeurlings]

[Originally blocks: GB-209]