2018-03-22 01:16:56 +08:00
|
|
|
<h1>Coding standard</h1>
|
2018-01-18 01:11:57 +08:00
|
|
|
|
|
|
|
|
> _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.
|
2018-03-22 01:16:56 +08:00
|
|
|
* Comments should not exceed 80 columns, code may exceed this limit a bit in
|
|
|
|
|
rare occasions if it results in clearer code.
|
2018-01-18 01:11:57 +08:00
|
|
|
|
|
|
|
|
Python
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
* All code must be compatible with Python 2.7, 3.5, and 3.6.
|
2018-03-22 01:16:56 +08:00
|
|
|
* [Pylint][pylintlink] should not give any error or warning (few exceptions
|
|
|
|
|
apply with external classes like `numpy`, see our `.pylintrc`).
|
|
|
|
|
* Python code follows [PEP8 style guide][pep8link] (use `autopep8` whenever
|
|
|
|
|
possible).
|
|
|
|
|
|
|
|
|
|
[pylintlink]: https://www.pylint.org/
|
|
|
|
|
[pep8link]: https://www.python.org/dev/peps/pep-0008/
|
2018-01-18 01:11:57 +08:00
|
|
|
|
|
|
|
|
C++
|
|
|
|
|
---
|
|
|
|
|
|
2018-03-22 01:16:56 +08:00
|
|
|
* 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][ue4link] with the exception of using
|
|
|
|
|
spaces instead of tabs.
|
|
|
|
|
* CarlaServer uses [Google's style guide][googlelink].
|
|
|
|
|
|
|
|
|
|
[ue4link]: https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/
|
|
|
|
|
[googlelink]: https://google.github.io/styleguide/cppguide.html
|
