Style guidelines

Different style guidelines are available under the respective sections of this page.

• Guidelines for code formatting
• Guidelines for #include directives
• Naming conventions
  • Files
  • Common guidelines for C and C++ code
  • C code
  • C++ code
  • Code for GPUs
  • Unit tests
• Allowed language features
  • Portability considerations
  • General considerations
  • Implementing exceptions for error handling
  • GPU API considerations
  • Preprocessor considerations
• Guidelines for creating meaningful issue reports
  • What to report
  • What should be included
  • Supporting the developers
  • General issue workflow
• Guidelines for formatting of git commits
  • General rules for newly submitted code
  • Guidelines for git commit messages
  • Concerning inline code comments
• Error handling
  • Brief summary on which method to use
  • Guiding principles
  • Specific rules

Guidelines for code formatting

Guidelines for indentation and other code formatting.

Guidelines for #include directives

Guidelines for #include style (ordering, paths to use, etc.).

Naming conventions

Naming conventions for files and various code constructs.

Allowed language features

Allowed language features.

Error handling

How to handle errors at run time

General guidelines for Doxygen markup

Guidelines for using Doxygen to document the source code are currently in a section on the page on general Doxygen usage.

Guidelines for creating meaningful issue reports

Guidelines for preparing and formatting bug reports.

Guidelines for formatting of git commits

Guidelines for formatting git commits when sending in proposed fixes for code review.