
Clang-Tidy 是一个基于 Clang 的 C++ 静态分析工具,能够检查代码中的常见错误、风格问题和潜在缺陷。它支持大量内置检查项,并可集成到构建流程中,帮助团队统一代码规范并提升代码质量。
安装 Clang-Tidy
大多数 Linux 发行版可通过包管理器安装:
- Ubuntu/Debian: sudo apt install clang-tidy
- Fedora: sudo dnf install clang-tools-extra
- macOS(使用 Homebrew): brew install clang-tidy
Windows 用户可从 LLVM 官网下载预编译版本,或通过 vcpkg 安装:
vcpkg install clang-tools基本使用方法
直接对单个源文件运行检查:
立即学习“C++免费学习笔记(深入)”;
clang-tidy main.cpp -- -std=c++17 -I/include/path其中 -- 后的内容是传递给 Clang 编译器的参数,确保头文件路径和语言标准正确。
若项目使用 CMake,推荐生成编译数据库(compile_commands.json),便于 clang-tidy 自动获取编译配置:
- cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
- 构建后会在 build 目录生成 compile_commands.json
有了编译数据库后,可直接运行:
clang-tidy src/*.cpp配置检查项
通过 .clang-tidy 配置文件控制启用的检查项和格式化选项:
Checks: > -*, # 禁用所有默认检查 modernize-*, # 启用现代 C++ 改进建议 readability-*, bugprone-*, performance-* WarningsAsErrors: '*' HeaderFilter: 'src/.*' # 只显示匹配路径的警告
常见检查类别包括:
- modernize-use-auto:建议使用 auto 简化类型声明
- readability-identifier-naming:命名规范检查(如变量名、函数名)
- performance-unnecessary-copy-initialization:避免不必要的拷贝
- bugprone-unchecked-optional-access:检查未验证 optional 是否有值
与编辑器和 CI 集成
多数现代编辑器支持实时调用 clang-tidy:
- VS Code 安装 C/C++ Extension Pack,启用 "C_Cpp.clang_format_fallbackStyle" 和诊断功能
- Vim 可通过 YouCompleteMe 或 ALE 插件触发检查
在 CI 流程中加入检查,防止低质量代码合入:
# GitHub Actions 示例
- name: Run clang-tidy
run: |
find src -name "*.cpp" | xargs clang-tidy -quiet -warnings-as-errors='*'
基本上就这些。合理配置 clang-tidy 能显著减少代码异味和潜在 bug,关键是根据团队规范定制 Checks 列表,并持续迭代规则。不复杂但容易忽略的是编译命令的准确性——没有正确的 include 路径和宏定义,误报会很多。










