Code style¶

In the code we follow google code style with the following changes:

  • Exceptions are allowed
  • Indentation must be 2 spaces. Tabs are not allowed.
  • No lines should exceed 120 characters.

All .h and .cpp files under $(BIGARTM_ROOT)/src/artm/ must be verified for code style with cpplint.py script. Files, generated by protobuf compiler, are the only exceptions from this rule.

To run the script you need some version of Python installed on your machine. Then execute the script like this:

python cpplint.py --linelength=120 <filename>

On Windows you may run this master-script to check all required files:

$(BIGARTM_ROOT/utils/cpplint_all.bat.