Code Style Guide¶
This document establishes the basic guidelines and recommendations for C and C++ programming styles within the srsRAN Project code base. Many of the guidelines are C++ specific, however some can still be applied to C. The main goal of this document is to help establish a consistent programming style throughout the srsRAN Project code base, and improve the readability and maintainability of code committed by users.
This document is heavily inspired in LLVM’s coding standards, please refer to this if you would like to take a further look into coding standards and best practices.
- Language and libraries
- Mechanical source aspects
- Style Aspects: High Level Issues
- Style Aspects: Low Level Issues
- Self Generating Documentation
- Commit Formatting