Skip to content

Guidelines.md

Latest commit

 

History

History
73 lines (52 loc) · 1.47 KB

Guidelines.md

File metadata and controls

73 lines (52 loc) · 1.47 KB

Guidelines

Style Guide

Clang-format

Use the provided .clang-format.

Naming conventions

The following naming conventions apply:

  • Namespace: snake_case
  • Macro: SCREAMING_SNAKE_CASE
  • Class: PascalCase
  • Struct: PascalCase
  • Enum: PascalCase
  • Enumerator: camelCase
  • Typedef: PascalCase
  • Union: PascalCase
  • Class Member Function: snake_case
  • Struct Member Function: snake_case
  • Class Member Field: snake_case
  • Struct Member Field: snake_case
  • Global Function: snake_case
  • Global Variable: snake_case
  • Parameter: snake_case
  • Local Variable: snake_case
  • Concept: snake_case

Please use the following pre-/suffixes:

  • Enumerator: eEnumerator
  • Class/Struct Private Member Field: m_field
  • Template type parameter: Type_T
  • Template variable parameter: variable_T
  • Concept: concept_c

Exceptions:

  • By default, write type trait aliases using _t suffix and snake_case. Type trait variables (like std::is_same_v) should also have the _v suffix.

Functions

Use trailing return type.

Class Scope Ordering

Declare everything that is public first!
The order within public/protected/private parts is the following:

  1. Type Aliases
  2. Nested Classes
  3. Friend Classes
  4. Static Variables
  5. Variables
  6. Static Methods
  7. Constructors / Destructors
  8. Operators
  9. Methods

Declare friend classes as private!

Coding Guide

Comments

Make your code self-documenting!

Other

  • Don't make class fields protected. Make a protected getter/setter instead.