VSCode怎么配置Clang-Tidy进行C++静态代码分析

星晨同学_5915

星晨同学_5915

2026-05-01

383人浏览

原创

clang-tidy在vscode中需手动启用并正确配置clang-tidy.path和compile_commands.json,否则不生效;检查范围通过clang-tidy.checks和headerfilterregex控制,但不支持--fix自动修复。

vscode怎么配置clang-tidy进行c++静态代码分析

Clang-Tidy 在 VSCode 中不会自动生效,必须显式启用并确保 compile_commands.json 可被正确读取,否则所有检查都只是“摆设”。

确认 clang-tidy 可执行文件已就位且路径正确

VSCode 的 C/C++ 扩展(ms-vscode.cpptools)依赖系统 PATH 或手动配置的 clang-tidy.path 才能找到工具。它不认别名、软链接或未加入 PATH 的本地安装路径。

  • 在终端运行 which clang-tidy(Linux/macOS)或 where clang-tidy(Windows),确认输出是真实可执行路径(如 /usr/bin/clang-tidy、C:\Program Files\LLVM\bin\clang-tidy.exe)
  • 若用 Homebrew 安装 LLVM,注意默认路径可能是 /opt/homebrew/bin/clang-tidy(Apple Silicon)或 /usr/local/bin/clang-tidy(Intel),需明确填入设置
  • VSCode 设置中搜索 clang-tidy.path,填入绝对路径;留空则 fallback 到 PATH,但 PATH 错误时静默失败,无提示
  • 不要填 clang-tidy-15 或带版本号的变体——除非你明确只用那个版本,且 .clang-tidy 配置里也匹配了该版本语义

compile_commands.json 必须存在且位置准确

VSCode 的 C/C++ 扩展通过 compile_commands.json 推导每个文件的包含路径、宏定义和语言标准。没有它,clang-tidy 会因无法解析头文件或模板而大量误报或直接跳过检查。

C++14
C++14

C++14 对 C++11 的修正与增强版本,适合旧系统维护和较老工具链兼容。

下载
  • 对 CMake 项目:在构建目录(如 build/)运行 cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..,生成后**把整个 compile_commands.json 文件复制到项目根目录**(VSCode 默认只从 workspace root 查找)
  • 不推荐用 -p build/ 参数让 VSCode 去子目录找——C/C++ 扩展不支持该参数透传,该配置项仅影响命令行调用
  • 验证是否加载成功:打开任意 .cpp 文件,按 Ctrl+Shift+P → 输入 “C/C++: Show References to Symbol at Cursor”,如果能跳转到系统头或第三方头,说明编译数据库已生效
  • 非 CMake 项目(如 Makefile)可用 compdb 或 bear -- make 生成,但 bear 有时漏宏定义,建议优先补全为 CMake

启用 clang-tidy 并控制检查范围

VSCode 默认禁用 clang-tidy,即使装了扩展也只跑微软原生分析器(MSVC/IntelliSense)。必须手动开启,并配合 headerFilterRegex 避免扫描第三方代码。

  • 在 VSCode 设置(settings.json)中添加:
    "clang-tidy.enabled": true,
    "clang-tidy.checks": [
      "-*",
      "modernize-*",
      "cppcoreguidelines-*",
      "performance-*",
      "bugprone-*"
    ],
    "clang-tidy.headerFilterRegex": "^(include|src|app)"
    
  • clang-tidy.checks 是字符串数组,不是单个字符串;通配符 -* 必须写在最前,否则默认检查仍会激活
  • headerFilterRegex 控制哪些头文件参与检查——不设它会导致 <vector></vector>、<qtwidgets></qtwidgets> 等全部被扫,产生海量无关警告
  • 若想禁用某条规则(如 cppcoreguidelines-owning-memory),直接在 checks 数组里加 "-cppcoreguidelines-owning-memory" 即可

自动修复(--fix)在 VSCode 中不可用

VSCode 的 C/C++ 扩展目前不支持 --fix 参数,编辑器内点击灯泡(?)只能跳转到问题位置或查看说明,不能一键重写代码。

  • 需要自动修复,只能回到终端手动运行:clang-tidy -p . --fix src/main.cpp
  • 修复后可能引入格式错乱(比如缩进、空格),建议紧接着跑一次 clang-format -i src/main.cpp
  • CI 流程中可安全使用 --fix + git diff --quiet 检查是否修改,但本地开发慎用——尤其涉及 auto 推导或移动语义时,自动替换可能改变语义
  • 真正容易被忽略的是:VSCode 编辑器内的波浪线警告来自 IntelliSense 引擎,和 clang-tidy 无关;只有“错误列表”(Problems panel)里标着 “clang-tidy” 的才是真实结果

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode c++

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3009

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1158

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3320

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14895

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程