What standards of development and documentation have you used in your practice?

In C/C++ development practice, the following standards and documentation approaches are often used:

• Coding:

  • Adherence to coding standards, such as the Google C++ Style Guide or MISRA C/C++ for embedded systems.
  • Use of clear variable and function names, consistent formatting.

• Documentation:

  • Comments in code using Doxygen for automatic documentation generation.
  • Descriptions of functions, parameters, return values, and possible errors.

• Version control and processes:

  • Use of version control systems (Git).
  • Following code review and CI/CD processes.

Example of a Doxygen comment:

/**
 * Calculates the sum of two numbers.
 * @param a First number
 * @param b Second number
 * @return Sum of a and b
 */
int sum(int a, int b) {
    return a + b;
}