腾讯云代码分析—IWYU使用指引

[xiohuang9]

工具介绍

include-what-you-use（简称IWYU）是一个分析C/C++工具，通过分析C/C++源文件中的#includes，可以消除不必要的头文件包含，减少编译时间，并提高代码的可读性和可维护性，自动跟踪和更新源代码中的依赖项也变得容易。

工具使用

$CXXFLAGS 是编译源文件时传递给编译器的参数，例如-I/path/to/Header（指定额外的头文件搜索路径)。

include-what-you-use $CXXFLAGS foo.cc

对于使用cmake构建的项目，可以通过命令生成complie_commands.json，该json包含了每个文件的CXXFLAGS，IWYU可通过该json对项目进行扫描分析

cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .

工具接入

1. 添加规则：进入页面，点击方案->规则配置 -> 自定义规则包-> 添加规则 ->搜索所属工具include-what-you-use->选择需要添加的规则 ->批量添加规则（支持一键添加工具规则）
   

2. 指定complie_commands.json路径：

环境变量名称	描述
COMPILE_JSON	字符串，相对代码库根目录路径

例如代码库目录结构为下所示情况时：
|---src
| |---base
| | |---test.h
| |---main.c
| |---complie_commands.json
|---README.m

COMPILE_JSON=src

3. 确保运行环境可编译生成complie_commands.json帮助工具对代码进行扫描分析

联系我们

欢迎访问我们的平台：腾讯云代码分析
使用文档：腾讯云代码分析帮助文档
持续为您的代码助力！
扫描可进开源群畅聊技术&答疑解惑