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

c++ clang-tidy配置 c++如何自定义clang-tidy的检查规则

云磊酱_1073

云磊酱_1073

发布时间:2026-03-28 14:50:03

|

692人浏览过

|

来源于php中文网

原创

clang-tidy 默认不读 .clang-tidy,仅当执行目录或其任意上级目录存在合法 YAML 格式的 .clang-tidy 文件时才加载;文件名必须为 .clang-tidy,不可改名,且需位于工作路径链中。

c++ clang-tidy配置 c++如何自定义clang-tidy的检查规则

clang-tidy 用哪个配置文件生效

clang-tidy 默认不读 .clang-tidy,除非你显式告诉它——它只在当前目录或父级目录中查找名为 .clang-tidy 的 YAML 文件,并且仅当该文件存在且语法合法时才加载。很多项目把配置放在子目录里,结果 clang-tidy 完全无视,就是因为没放对位置。

  • 配置文件必须叫 .clang-tidy(注意开头的点),不能是 clang-tidy.yaml 或 clang_tidy.yml
  • 它必须位于 clang-tidy 命令执行时的当前工作目录,或其任意上级目录(逐级向上查找,找到第一个就停)
  • 如果用 CMake + add_compile_options 或 set(CMAKE_CXX_CLANG_TIDY ...),CMake 会自动把构建目录下的 .clang-tidy 传给 clang-tidy,但前提是该文件确实存在于构建目录或源码根目录
  • 用 -config 参数可强制指定路径,比如 clang-tidy -config="{CheckOptions: [{key: readability-function-size.Threshold, value: '20'}]}",适合 CI 临时覆盖

如何禁用默认检查、只启用自定义规则

clang-tidy 默认启用一长串检查(clang-tidy --list-checks 能看到),但多数项目不需要全开。想“白名单式”启用,关键不是加 -checks,而是先清空再加——否则容易漏掉隐式启用的默认项。

  • 用 -checks=-*,readability-identifier-naming,bugprone-unchecked-optional-access:开头的 -* 是清除所有默认检查的唯一可靠写法
  • 别写成 -checks=*, -readability-*...,这种写法不会清空,只是禁用部分,其余默认项照常运行
  • 如果规则名拼错(比如 readability-identifer-naming 少个 f),clang-tidy 不报错,只是静默忽略——建议执行一次 clang-tidy -checks="readability-identifier-naming" --list-checks 确认是否在列表里
  • 某些检查依赖编译命令中的宏定义或头搜索路径,即使启用了,也可能因 -p 指向的 compile_commands.json 缺失信息而跳过,此时看输出里有没有 Skipping ... (no relevant compilation info)

自定义命名规则(readability-identifier-naming)怎么写才生效

readability-identifier-naming 是最常配也最容易配错的检查。它不接受简单开关,必须在 .clang-tidy 中提供完整的 CheckOptions 映射,且 key 名必须精确匹配文档里的格式(大小写、连字符、后缀都不能错)。

C++14
C++14

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

下载
  • 正确 key 是 readability-identifier-naming.NamingStyle,不是 readability-identifier-naming.Style 或 NamingRule
  • 值必须是 YAML 数组,每个元素含 Name、Type、Regex、Case(如 UpperCamelCase),缺一不可
  • 常见坑:Regex 里写 ^g_.* 但忘了 YAML 要引号包裹字符串,导致解析失败;或者 Case 写成 UPPER_CAMEL_CASE(实际只认 UpperCamelCase)
  • 示例片段:
    Checks: '-*,readability-identifier-naming'
    CheckOptions:
      - key: readability-identifier-naming.NamingStyle
        value: |
          - Name: 'Variable'
            Type: 'variable'
            Regex: '^([a-z][a-z0-9_]{2,})$'
            Case: 'lower_case'
          - Name: 'Class'
            Type: 'class'
            Regex: '^([A-Z][a-zA-Z0-9]+)$'
            Case: 'UpperCamelCase'

为什么改了 .clang-tidy 没反应?几个隐蔽原因

改完配置却没看到新规则报错,大概率不是 clang-tidy 不行,而是环境或调用链卡在某个环节。

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

  • CMake 构建系统可能缓存了旧的 CMAKE_CXX_CLANG_TIDY 值,删掉 build/CMakeCache.txt 和 build/CMakeFiles/ 后重新 cmake ..
  • 编辑器插件(如 VS Code 的 C/C++ Extension 或 clang-tidy 插件)通常不实时读取 .clang-tidy,需要重启插件或整个编辑器,甚至手动触发 “Reload Window”
  • clang-tidy 版本差异大:12 以前不支持 modernize-use-nodiscard,15 才稳定支持 cppcoreguidelines-avoid-magic-numbers 的 IgnoreMacros 选项——用 clang-tidy --version 确认版本,再查对应 LLVM 文档
  • 检查被 // NOLINT 或 // NOLINTNEXTLINE 注释屏蔽了,这类注释优先级高于配置,且不校验规则名是否真实存在

配置真正跑通的关键,往往不在 YAML 写得多漂亮,而在确认 clang-tidy 实际加载的是哪个文件、用的是哪个版本、走的是哪条调用路径。多打几次 clang-tidy -dump-config -p build/,比反复改配置更省时间。

热门AI工具

更多
WorkBuddy

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

切问学术

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

音述AI
音述AI Hot

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

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

DeepSeek

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

相关专题

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

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

2135

2023.08.07

json是什么
json是什么

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

3262

2023.08.23

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

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

1096

2023.10.13

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

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

3739

2025.09.10

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1738

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2684

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6064

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

5689

2023.11.24

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

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