General Documentation

Table of Content: Index

• 1. General rules applied in the code base
  • I. Introduction
  • II. Catkin Package and Repository Naming
  • III. Versioning
  • IV. Contribution Guidelines
    • IV.1. Code revision:
    • IV.2. Some rules for the contributors:
    • IV.3. Some rules for the reviewers:
  • V. Documentation
    • V.1 In-code documentation
    • V.2 Unit-tests and demos
• 2. C++ Coding Guidelines
  • I. Introduction
  • II. Folder Structure and File Naming
  • III. Naming
  • IV. Add Units to Variable Names
  • V. C/C++ Formatting
    • V.1. Line Length
    • V.2. Indentation
    • V.3. Position of braces
    • V.3. Spaces
    • V.4. Formatting of switch blocks
    • V.5. Clang-Format Configuration
  • VI. C/C++ Coding Guidelines
    • VI.1. Pass objects by const reference
    • VI.2. #pragma once vs Include Guards
    • VI.3. Keep scopes small
    • VI.4. Use types with explicit sizes