在线文档教程
Electron

在C ++代码上使用clang-format | Using clang-format on C++ Code

Using clang-format on C++ Code

clang-format 是一种自动格式化C / C ++ / Objective-C代码的工具,因此开发人员在代码审查期间不必担心样式问题。

强烈建议您在打开pull请求之前设置更改后的C ++代码的格式,这样可以节省您和审阅者的时间。

您可以安装clang-formatgit-clang-format通过npm install -g clang-format

要根据Electron C ++代码风格自动格式化文件,只需运行clang-format -i path/to/electron/file.cc。它应该在macOS / Linux / Windows上运行。

格式化您更改的代码的工作流程:

  • 在Electron存储库中更改代码。

  • 运行git add your_changed_file.cc

  • 运行git-clang-format,你可能会看到修改your_changed_file.cc,这些修改是从中生成的clang-format

  • 运行git add your_changed_file.cc并确认您的更改。

  • 现在分支已准备好作为拉取请求打开。

如果您想在最新的git commit(HEAD)上格式化已更改的代码,则可以运行git-clang-format HEAD~1。查看git-clang-format -h更多细节。

编辑器集成

您也可以clang-format直接集成到您喜欢的编辑器中。有关设置编辑器集成的进一步指导,请参阅以下页面: