Changes
Page history
Update Coding standards
authored
Jun 15, 2023
by
fima
Show whitespace changes
Inline
Side-by-side
Home/Coding-standards.md
View page @
09bfd474
Coding standards and guidelines for the QIM projects
### Code layout
-
Limit line length to 80 characters.
-
Use spaces around operators and after commas.
-
Add a space before and after inline comments.
### Naming conventions
-
Use descriptive names for variables, functions, and modules.
-
Use lowercase letters with underscores for module names.
-
Use CapWords (capitalized words with no underscores) for class names.
-
Use lowercase letters with underscores for function and variable names.
-
Avoid using single lowercase letters, except for simple counters or iterators.
### Comments and documentation
-
Use comments to explain complex code.
-
Use docstrings to document modules, classes, and functions.
-
Follow the "Google Style" for docstrings (reStructuredText format).
### Statements
-
Use a space after a comma and around operators.
-
Use is and is not for identity comparison, not == and !=.