# ClangFormat 作为替代格式化器

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/zh-cn/help/clion/llms.txt).

> **TL;DR**
> 设置 | 编辑器 | 代码样式 | C/C++
>
>
>
> 默认：已禁用
>
>
>
> 捆绑的  `.clang-format`  版本：请参阅  `设置 | 编辑器 | 代码样式 | C/C++ | Clang-Format`

[ClangFormat](https://clang.llvm.org/docs/ClangFormat.html) 是一款流行的代码格式设置工具，可帮助团队成员和 IDE 保持统一的代码样式。 它提供了一个选项，可将格式设置存储在名称为  `.clang-format`  或  `_clang-format`  的特殊 YAML 文件中。 在 CLion 中，可以使用   ClangFormat   作为内置代码格式化程序的替代方案。

## .clang-format 配置文件

包含格式设置约定的  `.clang-format`  文件应放置在项目树中。 每个文件都适用于同一级别和子目录中的代码文件。 对于单个项目，拥有多个  `.clang-format`  文件可让您在需要时为不同的代码文件夹使用不同样式。

ClangFormat   提供了许多 [样式选项](https://clang.llvm.org/docs/ClangFormatStyleOptions.html)，可以将这些选项组合起来，创建最适合团队的规则设置。 它还为 C/C++ 提供了几种内置样式： [LLVM](http://llvm.org/docs/CodingStandards.html)、 [Google](https://google.github.io/styleguide/cppguide.html)、 [WebKit](https://webkit.org/code-style-guidelines/)、 [Chromium](https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md) 和 [Mozilla](https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style)。 这些预定义样式可以按原样使用，也可以用作自定义样式定义设置的基准。

要生成一个采用 LLVM 代码样式等样式的  `.clang-format`  文件，请运行以下命令（确保 [ClangTools](https://clang.llvm.org/docs/ClangTools.html) 已 [安装](http://releases.llvm.org/download.html)）：

```CONSOLE
clang-format -style=llvm -dump-config > .clang-format
```

> **Tip:**
> 有一个方便的交互式   .clang-format   构建器： [clang-format 配置器](https://clang-format-configurator.site)。

## 在 CLion 中使用 ClangFormat

可以使用以下选项之一启用或禁用   ClangFormat  ：

Procedure:

* 要将  `.clang-format`  文件中的格式设置选项用于内置 CLion 格式化程序，请转到  `设置 | 编辑器 | 代码样式 | C/C++ | 常规 | C/C++ 格式设置引擎` ，选择   %instance% 格式化程序  ，并启用   从 .clang-format 文件读取代码样式   复选框。

![在代码样式设置对话框中启用 ClangFormat](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_engine.png)

* 或者，选择下面的   Clang-Format   选项。

* 在  `.h` 、  `.c`  或  `.cpp`  文件中时，点击状态栏中代码格式设置切换器的   启用 ClangFormat  ：

![从代码样式切换器启用 ClangFormat](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_switcherenable.png)

启用   ClangFormat   后，在以下情况下会应用相应的格式设置：

* 在编辑器中输入（包括在 `Enter` 或 `退格` 之后缩进、自动补全、代码生成、重构和快速修复）。

* 调用 代码 | 格式化代码 （ `Ctrl+Alt+L` (Windows), `⌘ ⌥ L` (macOS), `⌘ ⌥ L` (IntelliJ IDEA Classic (macOS)), `⌘ ⌥ L` (macOS System Shortcuts), `Ctrl+Alt+L` (XWin), `Ctrl+Alt+L` (GNOME), `Alt+Shift+L` (KDE), `Ctrl+Alt+L` (Emacs), `Ctrl+Alt+L` (Sublime Text), `⌘ ⌥ L` (Sublime Text (macOS)), `⌘ ⌥ L` (Xcode), `Ctrl+Alt+Enter` (Visual Studio), `⌘ ⌥ ⏎` (Visual Studio (macOS)), `Ctrl+Alt+L` (ReSharper), `⌘ ⌥ L` (ReSharper (macOS)), `Ctrl+;` (QtCreator), `⌘ ;` (QtCreator (macOS)), `Alt+Shift+F` (NetBeans), `Ctrl+Alt+L` (Eclipse), `⌘ ⇧ F` (Eclipse (macOS))）– 此操作还可让你重新格式化选中的代码，而不是整个文件。

* 在启用 重新设置代码格式 选项的情况下提交更改（ `Ctrl+O` (Windows), `⌃ O` (macOS), `⌃ O` (IntelliJ IDEA Classic (macOS)), `⌃ O` (macOS System Shortcuts), `Ctrl+O` (XWin), `Ctrl+O` (GNOME), `Ctrl+O` (KDE), `Ctrl+O` (Emacs), `Ctrl+O` (Sublime Text), `Ctrl+O` (Sublime Text (macOS)), `⌃ O` (Xcode), `Ctrl+O` (Visual Studio), `Ctrl+O` (Visual Studio (macOS)), `Ctrl+O` (ReSharper), `Ctrl+O` (ReSharper (macOS)), `Ctrl+O` (QtCreator), `Ctrl+O` (QtCreator (macOS)), `Ctrl+O` (NetBeans), `Ctrl+O` (Eclipse), `Ctrl+O` (Eclipse (macOS))）： ![提交前选择重新格式化代码选项。](https://resources.jetbrains.com/help/img/idea/2026.3/cl_commit_reformat.png)

Procedure: 更改 clang-format 二进制文件

1. 转到  `设置 | 编辑器 | 代码样式 | C/C++`  并打开   通用   选项卡。

2. 在   Clang-Format   部分中，设置   使用外部 clang-format 替代捆绑版本   并提供路径：

![设置自定义 clang-format 二进制文件](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_custom.png)

Procedure: 检查一个文件的 ClangFormat 设置

* 在编辑器中打开文件，然后从工具栏切换器中点击   显示已编辑文件的 ClangFormat 选项  ：

![查看文件的 ClangFormat 设置](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_viewsettings.png)

CLion 将显示从相应  `.clang-format`  文件获取的设置列表：

![ClangFormat 设置文件](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_settingsfile.png)

此列表目前为只读。 要编辑设置，请直接在  `.clang-format`  文件中更改它们。

Procedure: 编辑 .clang-format 文件

保存  `.clang-format`  文件时，CLion 会自动应用更改。

1. 在编辑器中打开所需的源文件，然后从工具栏切换器中点击   打开 '.clang-format'...  ：

![切换到 clang-format 文件](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_editconfig.png)

2. 为了帮助编辑  `.clang-format`  配置，CLion 会根据专为   ClangFormat   构建的 JSON 架构验证文件内容，从而提供编码辅助。 代码辅助功能包括：

* 选项和值的补全，并在弹出窗口中显示选项描述： ![clang-format 配置文件中的代码补全](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_completion.png)

* 检查选项值是否与允许的值设置一致： ![验证选项值](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_optionvaluesmatch.png)

* [快速文档弹出窗口](viewing-inline-documentation.html)（ `Ctrl+Q` (Windows), `F1` (macOS), `⌃ J` (IntelliJ IDEA Classic (macOS)), `⌘ I` (macOS System Shortcuts), `Ctrl+Q` (XWin), `Ctrl+Q` (GNOME), `Ctrl+Q` (KDE), `Ctrl+Q` (Emacs), `Ctrl+Q` (Sublime Text), `Ctrl+Q` (Sublime Text (macOS)), `⌘ ⌃ ⇧ /` (Xcode), `Ctrl+K, I` (Visual Studio), `⌘ K, I` (Visual Studio (macOS)), `Ctrl+Q` (ReSharper), `⌃ Q` (ReSharper (macOS)), `Ctrl+Q` (QtCreator), `Ctrl+Q` (QtCreator (macOS)), `Ctrl+Q` (NetBeans), `Alt+Middle-Click` (Eclipse), `⌥ Middle-Click` (Eclipse (macOS))），可帮助你了解选项详细信息： ![clang-format 配置文件的快速文档](https://resources.jetbrains.com/help/img/idea/2026.3/cl_clangformat_quickdoc.png)

Procedure: 将格式化器设置导出到 .clang-format 文件

当需要保存或共享内置代码格式化程序的设置时，可以将其导出到  `.clang-format`  文件中：

1. 转到  `设置 | 编辑器 | 代码样式 | C/C++` 。

2. 点击 ![](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.settings.svg)，位于   方案   字段旁边，并选择   导出 | .clang-format 文件  ：

![将格式化程序设置导出到 .clang-format](https://resources.jetbrains.com/help/img/idea/2026.3/cl_codestyles_export_to_clangformat.png)

3. 在打开的对话框中，指定文件名和位置。 默认情况下，CLion 会建议  `.clang-format`  和当前项目根目录。

