Coding Conventions

• Classes
  • Constructor
  • Destructor
  • Getters, Setters, Attribute Functions
  • Boolean Member Functions
  • Class Invariant
  • Uncopyable
  • Indestructible
  • Avoid Protected Data
  • Prefer Concrete Types Over Class Hierarchies
  • Use =default and =delete Wherever Possible
  • Virtual Functions Should Specify Exactly one of Virtual, Override, or Final
  • Ordering
• Comments
  • Language
  • Style
  • Code Expressiveness
  • Amplification
  • End-of-line Comments
  • FIXME and TODO Notes
  • Deprecation
• Constants
  • Const Correctness
  • Function Declarations and Definitions
• Disallowed Features
  • Dynamic Memory
  • RTTI
  • Exception Handling
• Enumerations
  • Concept
  • Unscoped Enumerations
  • Scoped Enumerations
• Files
  • Including Header Files
  • Standard Headers
• Functions
  • A Function Should Perform a Single Logical Operation
  • Keep Functions Short and Simple
  • If a Function Might Have to be Evaluated at Compile Time, Declare it constexpr
  • For “in” Parameters, Pass Cheaply-Copied Types by Value and Others by Reference to const
  • Raw Pointer Arguments
  • Raw Byte Array Arguments
  • Translation-Unit Local Functions
  • Lambdas
• Initialization
  • Overview
  • Direct Initialization
  • List Initialization
  • Value Initialization
  • Non-static Data Member Initialization (NSDMI)
  • Conclusion
• Namespaces
  • Using Namespaces
  • Place Helper Functions in the Same Namespace as the Class They Support
  • Use the using namespace Directive Sparingly
• Naming Conventions
  • General Naming Rules
  • Type Names
  • Variable Names
  • Constant Names
  • Function Names
  • Classes
  • Namespace Names
  • File Names
  • Module Names
  • Special Cases
• Statements and Expressions
  • Expressions with Booleans
  • Trivial if-else
  • Avoid Magic Constants
  • Null Pointer
  • Order of Evaluation
  • Asserts
  • Forward Declarations
  • Prefer Using Over typedef for Defining Aliases
  • OS Specific Code
  • Critical Sections
  • Buffers
  • Delays
  • Retries