讲师中心 微信公众号
AI工具推荐 视频效率加速

Clang-Tidy如何在c++项目中进行静态代码检查 提升代码质量【工程化】

阿瑶同学_5463

阿瑶同学_5463

发布时间:2025-12-31 18:41:02

|

321人浏览过

|

来源于php中文网

原创

Clang-Tidy 是 LLVM 提供的 C++ 静态分析工具,需嵌入构建流程、统一规则并持续反馈;推荐通过 CMake 集成,支持配置文件、CI 门禁、本地实时检查及自动修复,核心是规则可配、执行可嵌、结果可溯、修复可自动化。

clang-tidy如何在c++项目中进行静态代码检查 提升代码质量【工程化】

Clang-Tidy 是 LLVM 项目提供的 C++ 静态分析工具,能自动检测代码中潜在的 bug、风格问题、性能隐患和不安全用法。在工程化实践中,它不是“跑一次就完事”的玩具,而是需要嵌入构建流程、统一规则、持续反馈的基础设施。

集成到 CMake 构建系统(推荐方式)

现代 C++ 项目多用 CMake,Clang-Tidy 可通过 CMAKE_CXX_CLANG_TIDY 变量直接启用:

  • 在 CMakeLists.txt 根目录添加:
    set(CMAKE_CXX_CLANG_TIDY "clang-tidy;-checks=-*,cppcoreguidelines-*,modernize-*,performance-*,bugprone-*,cert-*" CACHE STRING "Clang tidy checks")
  • 确保使用 Ninja 或 Make 等支持编译数据库(compile_commands.json)的生成器:
    cmake -G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
  • 构建时,Clang-Tidy 会自动对每个编译单元执行检查,并将结果输出到终端或日志中

定制检查规则并维护配置文件

硬编码在 CMake 中不易维护,建议抽离为独立配置文件:

  • 创建 .clang-tidy 文件(放在项目根目录),内容示例:
    Checks: '-*,cppcoreguidelines-*,modernize-use-nodiscard,-cppcoreguidelines-owning-memory,-modernize-use-auto'<br>WarningsAsErrors: true<br>HeaderFilterRegex: '^(include|src)'
  • 该文件会被 Clang-Tidy 自动识别,优先级高于命令行参数
  • 用 - 前缀禁用特定检查,用 , 分隔多个规则,支持通配符

与 CI/CD 流水线结合实现门禁控制

避免低质量代码合入主干,需在 CI 中强制执行并阻断失败构建:

Permanently Clear Files from Git History
Permanently Clear Files from Git History

帮助用户永久删除 Git 仓库历史中的文件,适用于用户提及 “git filter-repo” 等场景。

下载

立即学习“C++免费学习笔记(深入)”;

  • 在 GitHub Actions / GitLab CI 中调用:
    run-clang-tidy -p build/ -fix -quiet | tee clang-tidy-report.txt
  • 使用 -fix 自动修复可安全修改的问题(如添加 override、[[nodiscard]])
  • 配合 clang-tidy-diff.py(LLVM 提供脚本)只检查本次 PR 修改的代码,提升效率和精准度
  • 将报告转为 SARIF 格式,接入 GitHub Code Scanning,实现问题直接标注在 PR diff 上

开发者本地高效使用习惯

静态检查的价值取决于是否被开发者真正感知和响应:

  • VS Code 安装 C/C++ Extension Pack + Clang-Tidy 插件,编辑时实时高亮问题
  • 在终端快速对单个文件检查:
    clang-tidy src/main.cpp -- -Iinclude -std=c++17
  • 定期运行全量扫描并生成 HTML 报告:
    run-clang-tidy -p build/ -export-fixes=fixes.yaml && clang-tidy -export-fixes=report.html
  • 把常用检查组合成别名,例如:
    alias ct-check='clang-tidy -p build/ -checks="cppcoreguidelines-*,modernize-*"'

Clang-Tidy 的工程化落地核心是:规则可配置、执行可嵌入、结果可追溯、修复可自动化。它不替代 Code Review,但能把重复性、机械性的质量判断交给机器,让团队聚焦更高阶的设计与逻辑问题。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

1995

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2802

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

956

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

3159

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

5479

2023.08.02

github中文官网入口 github中文版官网网页进入
github中文官网入口 github中文版官网网页进入

github中文官网入口https://docs.github.com/zh/get-started,GitHub 是一种基于云的平台,可在其中存储、共享并与他人一起编写代码。 通过将代码存储在GitHub 上的“存储库”中,你可以: “展示或共享”你的工作。 持续“跟踪和管理”对代码的更改。

8285

2026.01.21

GitHub官网入口版本汇总
GitHub官网入口版本汇总

本专题整合了GitHub入口版本地址汇总,阅读专题下面的文章了解更多详细内容。

778

2026.04.02

数据库三范式
数据库三范式

数据库三范式是一种设计规范,用于规范化关系型数据库中的数据结构,它通过消除冗余数据、提高数据库性能和数据一致性,提供了一种有效的数据库设计方法。本专题提供数据库三范式相关的文章、下载和课程。

2385

2023.06.29

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 219人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn