Перейти к основному содержанию

Использование clang-format на C++ коде

clang-format это инструмент для автоматического форматирования кода на C/C++/Objective-C code, он используется для того, чтобы в процессе ревью разработчики не беспокоились о проблемах, связанных с форматированием.

Настоятельно рекомендуется форматировать измененный вами код C++ перед открытием пулл-реквестов, это сэкономят время вам и ревьюверам.

Вы можете установить clang-format и git-clang-format командой npm install -g clang-format.

To automatically format a file according to Electron C++ code style, run clang-format -i path/to/electron/file.cc. It should work on macOS/Linux/Windows.

Процесс форматирования измененного вами кода:

  1. Сделать изменения кода в репозитории Electron.
  2. Запустите git add your_changed_file.cc.
  3. Выполните git-clang-format, и вы вероятно увидите изменения в your_changed_file.cc, эти изменения сформированы из clang-format.
  4. Запустите git add your_changed_file.cc, и выполните commit.
  5. Теперь эта ветка готова для открытия пулл-реквеста.

If you want to format the changed code on your latest git commit (HEAD), you can run git-clang-format HEAD~1. See git-clang-format -h for more details.

Интеграция с редактором кода​

You can also integrate clang-format directly into your favorite editors. For further guidance on setting up editor integration, see these pages: