User Tools

Site Tools


documentation:coding_guidelines

Coding guidelines

General rules

  • Improve maintainability
    1. Do not duplicate code : use function instead
    2. Minimize dependencies between classes
  • Improve readability
    1. Write small functions : < 200 lines
    2. Use explicit class and variable names
    3. Use comments only when necessary : everyone should understand your code
    4. Improve class cohesion and coherence

Coding style

documentation/coding_guidelines.txt ยท Last modified: 2021/12/13 09:28 by 127.0.0.1