Files

HuangWei 4e868252fc Add .clang-format and docs (#2724 )

The problem of inconsistence style in Doris code is too big, it's hard to minimize modification when reformatting code.
So here, our aim is to make the style rules, tune the config in .clang-format.

Note: I choose clang-format-8.0+ to support richer sytle options.

2020-01-11 20:54:20 +08:00

2.4 KiB

Raw Blame History

代码格式化

为了自动格式化代码，推荐使用clang-format进行代码格式化。

代码风格定制

Doris的代码风格在Google Style的基础上稍有改动，定制为.clang-format文件，位于Doris根目录。

目前，.clang-format配置文件适配clang-format-8.0.1以上的版本。

环境准备

需要下载安装clang-format，也可使用IDE或Editor提供的clang-format插件，下面分别介绍。

下载安装clang-format

Ubuntu: apt-get install clang-format

当前版本为10.0，也可指定旧版本，例如: apt-get install clang-format-9

Centos 7:

centos yum安装的clang-format版本过老，支持的StyleOption太少，建议源码编译10.0版本。

clang-format插件

Clion IDE可使用插件"ClangFormat"，File->Setting->Plugins搜索下载。但版本无法和 clang-format程序的版本匹配，从支持的StyleOption上看，应该是低于clang-format-9.0。

使用方式

命令行运行

clang-format --style=file -i $File$

--sytle=file就会自动找到.clang-format文件，根据文件Option配置来格式化代码。

批量文件clang-format时，需注意过滤不应该格式化的文件。例如，只格式化*.h/*.cpp，并排除某些文件夹：

find . -type f -not $ -wholename ./env/* $ -regextype posix-egrep -regex ".*\.(cpp|h)" | xargs clang-format -i -style=file

在IDE或Editor中使用clang-format

Clion

Clion如果使用插件，点击Reformat Code即可。

VS Code

VS Code需安装扩展程序Clang-Format，但需要自行提供clang-format执行程序的位置。

"clang-format.executable":  "$clang-format path$",
"clang-format.style": "file"

然后，点击Format Document即可。

2.4 KiB Raw Blame History