在VSCode中使用clang-format

发布于 2024-12-09 09:56:42 浏览：212 订阅该版

[tocm]

# 在VSCode中使用clang-format

[在rtt官方仓库的文档中](https://github.com/RT-Thread/rt-thread/blob/master/tools/release/README.md)，介绍了.clang-format的使用方法，但是使用过程中会产生各种问题，例如
```shell
NameError: name 'original' is not defined
```

并且使用时也很繁琐，因此，我们可以使用VSCode的插件来简化使用方法，方便开发：

## 配置过程

我使用**wsl**为开发环境，环境配置如下

![171150315260377.png](https://oss-club.rt-thread.org/uploads/20241209/4c1242f0b80b99a69b7709e571d66417.png.webp)
首先下载VSCode插件`Clang-Format`
在wsl中查看版本号
```c
clang-format --version
```
由于rtt团队使用的clang-format需要支持较高的版本，经测试version<14.0均不可使用，因此我选择clang-format-18，各位可以测试下16版本是否能够正常使用
由于ubuntu 22.04仅支持clang-format-14版本，因此我们需要添加llvm的仓库源
执行下列命令获取gpg key
```c
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
```

根据操作系统版本在`/etc/apt/sources.list`末尾追加[如下仓库源](https://apt.llvm.org/)，我使用18版本的因此只需要添加  
```shell
# 18
deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main
deb-src http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main
```
更新apt源
```shell
sudo apt update
```
搜索clang-format版本
```shell
apt search clang-format
```
下载
```shell
sudo apt install clang-format-18
```
卸载之前的版本（假如有的话）
```shell
sudo rm /usr/bin/clang-format
```
安装现有版本
```shell
sudo ln -s /usr/bin/clang-format-18 /usr/bin/clang-format
```
我们再看一眼当前版本
```shell
clang-format --version
```
显示是你新安装的版本就没有问题了

回到VSCode，接下来设置VSCode和clang-format插件
打开文件(file)-首选项(preference)-设置(setting)，搜索`save`并找到`Format On Save Mode`以及`Format On Save`，按你的喜好设置，我设置为如下选项：

![91883915256932.png](https://oss-club.rt-thread.org/uploads/20241209/c312f59bea070b6bb1e8b41770bca725.png.webp)

![446314015252686.png](https://oss-club.rt-thread.org/uploads/20241209/66c2200d38b11089489a0001779d25c8.png.webp)

打开.vscode/setting.json文件，添加如下内容：
```json
"clang-format.executable": "/usr/bin/clang-format"
```

之后将官方仓库中的`tools/.clang-format`拷贝到你的工作目录下

在VSCode中右键-格式化文档即可使用，如果你在前面勾选了`format on save`，那么在你保存时也会进行格式化处理

参考文档：
[掘金](https://juejin.cn/post/7020308474546372645)
[CSDN](https://blog.csdn.net/zmlovelx/article/details/105295064)