C++ style guide (might be done partly)

[ValentinKarnaukhov]

We are looking for contributor with C++ skills to write a style guide for C++.

Target file here

Style guide should contains

• Code Formatting:

  • Indentation (number of spaces or tabs).
  • Line length (maximum number of characters per line).
  • Placement of curly braces.
  • Rules for empty lines and spaces.

• Naming Conventions

  • Conventions for naming variables, functions, classes, and constants.
  • Use of camelCase, PascalCase, or snake_case.
  • Rules for naming private and public members.

• Code Structure

  • Organization of files and directories.
  • Order of methods and fields in a class.
  • Separation of logic into modules and functions.

• Comments

  • Use and formatting of comments.
  • Documentation of functions and methods (e.g., using Javadoc, docstrings, etc.).
  • Comments for complex or non-trivial sections of code.

• Examples and Best Practices

  • Examples of well-written code.
  • Illustrations of typical errors and how to avoid them.