coding►c++

c++ style guide

风格指南

Google C++ Style Guide

注释文档化

工程中使用统一代码风格

.clang-format

安装工具

1
brew install clang-format

导出指定格式的 .clang-format 配置文件

1
2
clang-format -style=Google -dump-config > .clang-format
clang-format -style=llvm -dump-config > .clang-format

格式化文件

1
2
3
4
5
6
7
8
$ cat t.cpp
#include "iostream"
int main() {
return 0;
}
$ clang-format -style=Google t.cpp
#include "iostream"
int main() { return 0; }

Inplace 格式化文件

1
$ clang-format -style=Google -i t.cpp

在 IDE 中使用 .clang-format

  • CLion 可以识别并应用项目根目录下的 .clang-format 文件，如果没有的话，可以点击右下角的 spaces 信息框，再点击 Enable ClangFormat

image-20231110182136072

跳过格式化

1
2
3
// clang-foramt off
{codes}
// clang-foramt on

Clangformat 配置示例

1
2
3
4
5
6
7
8
---
# use defaults from the LLVM style
BasedOnStyle: LLVM
ColumnLimit: 120
---
Language: Proto
# Don't format .proto files.
DisableFormat: true