如何让Visual Studio调用clang-tidy时使用.clang-tidy配置文件？

问题背景 #

Visual Studio桌面版已集成clang-tidy功能，官方文档说明支持使用自定义.clang-tidy配置文件，但手动配置后执行代码分析时配置未生效。

解决步骤 #

1. 放置配置文件到正确位置

   • 将.clang-tidy文件放在项目根目录（单项目场景）或解决方案根目录（多项目解决方案场景）。clang-tidy会自动从当前文件目录向上查找配置文件，确保文件层级能覆盖目标项目。

2. 调整VS项目属性配置

   • 打开项目属性页，导航至「配置属性 > 代码分析 > Clang-Tidy」
   • 将Clang-Tidy Checks属性设置为*或留空：若该属性指定了具体检查项，会作为--checks参数传入clang-tidy，优先级高于配置文件，导致配置文件失效。
   • 确认「启用Clang-Tidy」选项设置为「是」。

3. 验证配置生效

   • 打开开发者命令提示符，进入项目目录，执行clang-tidy -list-checks，查看输出的检查项是否与.clang-tidy中的配置一致。
   • 在VS中重新生成项目，执行「生成 > 运行代码分析 > 对[项目名]运行代码分析」，检查分析结果是否符合配置文件规则。

常见排查点 #

• 版本兼容问题：若VS内置clang-tidy版本与本地命令行版本不一致，可能存在配置语法兼容问题。可在项目属性页的「Clang-Tidy可执行文件路径」中指定本地clang-tidy的路径，确保版本统一。
• 配置文件语法错误：确保.clang-tidy文件格式正确，比如检查项的命名、配置缩进等，参考标准clang-tidy配置格式编写。

内容的提问来源于stack exchange，提问作者Elad Maimoni