当前位置:

首页 > 编程开发 > C++如何用Clang-Tidy做代码检查

C++如何用Clang-Tidy做代码检查

使用Clang-Tidy进行C++静态分析需先生成compile_commands.json,通过CMake开启CMAKE_EXPORT_COMPILE_COMMANDS选项,并用clang-tidy或run-clang-tidy结合.checks配置检查项,实现单文件或批量代码分析,推荐在项目根目录配置.clang-tidy文件定义默认规则,并集成至CI/CD或编辑器以提升代码质量。

本文目录

    使用Clang-Tidy进行C++静态分析需先生成compile_commands.json,通过CMake开启CMAKE_EXPORT_COMPILE_COMMANDS选项,并用clang-tidy或run-clang-tidy结合.checks配置检查项,实现单文件或批量代码分析,推荐在项目根目录配置.clang-tidy文件定义默认规则,并集成至CI/CD或编辑器以提升代码质量。

    C++怎么使用Clang-Tidy进行静态分析_C++代码检查与Clang-Tidy应用

    要使用 Clang-Tidy 进行 C++ 静态分析,核心在于配置项目构建系统以生成编译命令,并运行 Clang-Tidy 对源码进行检查。Clang-Tidy 是 LLVM 项目的一部分,能够检测代码中的潜在错误、风格问题和不推荐的写法,支持大量可配置的检查项。

    生成编译数据库(compile_commands.json)

    Clang-Tidy 需要知道每个源文件的完整编译命令,因此必须先生成 compile_commands.json 文件。最常见的方式是通过 CMake 配合 Ninja 或 Make 构建系统。

    • 在项目构建目录中使用 CMake 并开启 CMAKE_EXPORT_COMPILE_COMMANDS:

    cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -GNinja ..

    • 执行后会在构建目录生成 compile_commands.json,Clang-Tidy 会自动读取它。

    运行 Clang-Tidy 检查单个文件

    在有了编译数据库之后,可以直接对某个源文件运行检查:

    clang-tidy src/main.cpp

    • Clang-Tidy 会根据 compile_commands.json 获取编译参数,分析代码并输出警告。
    • 若想启用特定检查项,可用 -checks= 参数:

    clang-tidy src/main.cpp -checks='readability-*,cppcoreguidelines-*'

    • 使用 - 排除某些规则:

    clang-tidy src/main.cpp -checks='*, -cppcoreguidelines-pro-bounds-pointer-arithmetic'

    批量检查多个文件

    手动逐个文件检查效率低,可借助脚本或工具自动化处理。

    • 使用 find 命令查找所有 .cpp 文件并执行 Clang-Tidy:

    find src/ -name '*.cpp' | xargs clang-tidy

    • 更推荐使用 run-clang-tidy 脚本(随 Clang-Tidy 安装):

    run-clang-tidy -checks='readability-*,modernize-*'

    • 该脚本能自动读取编译数据库并并行处理多个文件。

    配置默认检查项(.clang-tidy 文件)

    在项目根目录添加 .clang-tidy 文件,可以定义默认行为,避免每次输入重复参数。

    示例配置:

    Checks: '-*,cppcoreguidelines-*,readability-*,modernize-*'
    WarningsAsErrors: ''
    HeaderFilter: '.*'
    FormatStyle: file

    • Checks 指定启用或禁用的检查规则。
    • HeaderFilter 控制是否显示头文件的警告。
    • FormatStyle: file 支持与 .clang-format 协同进行代码格式化。

    集成到开发流程

    将 Clang-Tidy 加入 CI/CD 或编辑器,能有效提升代码质量。

    • 在 GitHub Actions 中添加步骤:

    run: run-clang-tidy -checks='modernize-use-nullptr' || exit 0

    • 在 VS Code 中安装 C/C++ Extension Pack,配合配置可实现实时提示。
    • 也可结合 Clang-Format 在保存时自动修复部分问题。

    基本上就这些。只要生成了正确的编译数据库,并合理配置检查项,Clang-Tidy 就能成为 C++ 开发中强大的静态分析助手。不复杂但容易忽略的是编译命令的准确性——如果 compile_commands.json 缺失或路径错误,Clang-Tidy 将无法正确解析头文件依赖。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    WorkBuddy怎么用API接口?有开发文档吗
    WorkBuddy怎么用API接口?有开发文档吗

    WorkBuddy 目前没有面向普通用户的公开 REST API 接口文档,扩展与集成走四条官方路径:接入 MCP 服务扩展工具能力、用连接器打通外部应用(支持公共/个人授权)、编写技能(Skill)与专家包定制工作流、在开放平台发布 Buddy 应用。另支持接入 OpenAI 兼容的自定义模型。本文含 4 张真实界面截图并如实说明现状。

    Google Workspace MCP OAuth 2.0迁移节点已过,旧客户端、普通REST与服务账户分别适用什么规则
    Google Workspace MCP OAuth 2.0迁移节点已过,旧客户端、普通REST与服务账户分别适用什么规则

    解释Google Workspace MCP 11月11日与12日的agentic OAuth客户端迁移节点,区分普通REST应用、混合客户端、预览资格、用户权限和服务账户、Apps Script边界。

    OpenAI Agents SDK v0.24.0-alpha.8升级前为何要备份状态?
    OpenAI Agents SDK v0.24.0-alpha.8升级前为何要备份状态?

    OpenAI Agents SDK v0.24.0-alpha.8预览版新增执行前审批、自有模型客户端、Realtime与预算检查点恢复,说明alpha.7回退、Linux运行及工具认证边界。

    Claude Trading Skills六项诊断修复覆盖哪些密钥泄漏路径?
    Claude Trading Skills六项诊断修复覆盖哪些密钥泄漏路径?

    Claude Trading Skills六项技能已修复API密钥异常日志泄漏路径;not_verified保留完整安全审核缺口,离线回归通过不等于实盘验收或全面认证。

    Microsoft C++ Language Server内置MSBuild提取器后,自动化范围和使用资格怎样理解
    Microsoft C++ Language Server内置MSBuild提取器后,自动化范围和使用资格怎样理解

    解释Microsoft C++ Language Server预览版的MSBuild编译数据库自动提取,区分CMake、自定义构建、有效Copilot订阅和CLI能力,避免把测试预发布版本当最低稳定版。

    LibreOffice宏怎么用?Python脚本能调用吗
    LibreOffice宏怎么用?Python脚本能调用吗

    LibreOffice可通过“工具→宏”创建和运行Basic宏,也支持由Python脚本提供程序运行Python宏。两种方式都可以使用UNO接口操作文档;Excel VBA只有有限兼容支持,不能把所有Excel宏直接复制过来当作LibreOffice原生宏执行。

    GitHub企业Copilot席位API开放应用调用后,读取和席位变更有什么区别
    GitHub企业Copilot席位API开放应用调用后,读取和席位变更有什么区别

    说明Enterprise GitHub Apps的Copilot席位管理权限,提供第一页只读GET示例,区分total_seats、授权明细、遥测活动和待取消计费条件。

    GitHub网页仪表盘默认视图、单行标题和六项列表分别改变什么
    GitHub网页仪表盘默认视图、单行标题和六项列表分别改变什么

    解释GitHub网页仪表盘Feed或Home默认视图、六项列表、自定义选择保留和Agent sessions隐藏条件,区分布局、数据与权限。

    LangChain Python 1.4.10、JS core 1.3.7与langchain 1.6.4为什么要区分拒答和失败
    LangChain Python 1.4.10、JS core 1.3.7与langchain 1.6.4为什么要区分拒答和失败

    核对LangChain三种包版本,解释refusal内容块、ModelRefusalError与中间件传递,提供自定义错误分支示例并区分Python消息流和追踪修复。

    Anthropic Python/Ruby 2.8.0、TS 1.8.0、Go 2.9.0、Java 3.8.0参数校验应如何理解
    Anthropic Python/Ruby 2.8.0、TS 1.8.0、Go 2.9.0、Java 3.8.0参数校验应如何理解

    区分Anthropic各语言SDK及TypeScript云适配包版本,解释Claude Tag字段、Bedrock/Vertex分号差异、非法路径参数和只读Python版本核对。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。