SuperAPI AI 工具集

cpp-quality

编程与开发

查看项目

更新于 11-14 00:48

技能介绍

cpp-quality 是一份 C++ 质量工具速查与配置参考,围绕格式化、静态分析、头文件依赖优化和 CI 集成展开,给出各工具的核心配置片段、运行命令与注意事项。

用途:为 C++ 项目建立可落地的代码质量保障流程,覆盖代码风格统一、缺陷模式检测、编译警告强化、头文件精简,以及把这些检查接入持续集成。

主要能力:

  1. clang-format:按样式文件重排源码,毫秒级运行,可接入 pre-commit 与编辑器。资料提供了 .clang-format 示例(基于 LLVM、C++20、列宽 100 等),并给出格式化、CI 检查(--dry-run --Werror)和对 git 跟踪文件批量运行的命令。
  2. clang-tidy:依赖 compile_commands.json 的 linter 与简单重构工具。资料给出 .clang-tidy 示例,启用 bugprone、cert、clang-analyzer、concurrency、cppcoreguidelines、modernize、performance、portability、readability 等检查类别,并列出单文件、全项目并行、自动修复和 CMake 目标等运行方式,以及 NOLINT 抑制写法和高价值检查类别说明。
  3. cppcheck:作为互补工具,资料给出启用 warning、style、performance、portability、内联抑制、错误退出码和项目编译数据库的运行命令,说明其与 clang-tidy 检查模式不同,可发现部分 clang-tidy 遗漏的未初始化成员和悬空引用问题。
  4. include-what-you-use(IWYU):减少头文件膨胀,提供 iwyu_tool.py 与 fix_includes.py 的用法,以及 IWYU pragma 注释覆盖方式。
  5. 编译器警告:给出 MSVC 与 GCC/Clang 的警告选项示例,强调编译器警告是免费且更快的基础层,不应因使用 clang-tidy 而跳过。
  6. CI 流水线:给出 GitHub Actions 草图,依次执行配置、格式检查、构建、clang-tidy 和测试。

使用方式:资料以配置文件和命令行示例为主,需在项目根目录放置 .clang-format 与 .clang-tidy,CMake 中开启导出编译命令,然后按示例命令运行各工具;CI 中串联格式检查、构建、静态分析和测试步骤。

适用场景:C++ 项目的代码风格统一、静态缺陷检测、头文件依赖治理、编译警告强化,以及把质量检查纳入 CI。

限制:资料为速查参考,未提供完整安装步骤、版本兼容性说明、性能基准、收费或平台信息;部分命令和配置需结合项目实际调整。