Style Guide

Style Guide for C++

• 4 space indentation

• snake_case for variables filenames

• underscores after class member variables

  • eg. int size_

• camelCase for functions, methods

• PascalCase (capitalised camelCase) for classes

Refer to the Google Style Guide for naming.

Style Guide for Python

rUNSWift uses the Python community’s standard PEP8, as enforced by flake8 in a git hook.

Tip

As PEP8 is strict, install a python linter for your IDE.

See also

IDE Addons for linters for your IDE

EditorConfig file

EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.

$RUNSWIFT_CHECKOUR_DIR/.editorconfig file contains the style settings for different languages.

See also

IDE Addons to see editorConfig addons for your IDE