Coding Conventions
Overview
This section defines the RAPIDSEA coding conventions for C header (.h) and source (.c) files to ensure consistency, readability, and maintainability.
Naming Conventions
Naming conventions in C programming specify how to name variables, functions, and files. These conventions help make code easier to understand and maintain.
Please refer to the below section for RAPIDSEA naming conventions.
See also
Documentation Format
Must use Doxygen/sphinx style comments format.
Please refer to the below section for RAPIDSEA Documentation format examples.
See also
Coding Style and Methods
Our RAPIDSEA stack contains many components, so it is essential to follow the coding style and flow methods as per the guidelines.
Please refer to the section below for the RAPIDSEA coding style and method descriptions.
See also
Error Handling
Our RAPIDSEA Stack already defines the error codes and uses these error codes within the stack.
rs_errno.h - Error code header file is available under $REPO/inc/rapidsea/components/core/
Please refer to the section below for the RAPIDSEA Error code details.
See also
Conclusion
Following these conventions ensures consistency, improves maintainability, and enhances collaboration in C projects.