carla/Docs/coding_standard.md

1.1 KiB

Coding standard

This document is a work in progress and might be incomplete.

General

  • Use spaces, not tabs.
  • Avoid adding trailing whitespace as it creates noise in the diffs.
  • Comments should not exceed 80 columns, code may exceed this limit a bit in rare occasions if it results in clearer code.

Python

  • All code must be compatible with Python 2.7, 3.5, and 3.6.
  • Pylint should not give any error or warning (few exceptions apply with external classes like numpy, see our .pylintrc).
  • Python code follows PEP8 style guide (use autopep8 whenever possible).

C++

  • Compilation should not give any error or warning (clang++ -Wall -Wextra -std=C++14).
  • Unreal C++ code (CarlaUE4 and Carla plugin) follow the Unreal Engine's Coding Standard with the exception of using spaces instead of tabs.
  • CarlaServer uses Google's style guide.