2. Style Guide

foxBMS 2 has its own style guide, which is a set of conventions about how to write code and documentation. We enforce a consistent style as it makes it easier to understand the overall project. This project has general rules and special rules for C/C++, Python, reStructuredText files and batch and shell scripts.

The following sections describe the project’s general and language specific guidelines.

• 2.1. General Rules
• 2.2. C Coding Guidelines
• 2.3. Python Coding Guidelines
• 2.4. reStructuredText Coding Guidelines
• 2.5. Batch and Shell Coding Guidelines
• 2.6. YAML Coding Guidelines
• 2.7. Table of Rules