最近用了 include-what-you-use 这个工具，分享一下 https://yodalee.me/2020/10/2020_iwyu/ 大家都知道，程式不是写完就算了，是会长大跟更新 这时候 include 就会慢慢过时，可能本来需要的 include 现在不需要了 但通常在改程式码时不会意识到这点 如果参考 Google 的 cpp coding guide，会看到 Include What You Use 这条准则： If a source or header file refers to a symbol defined elsewhere, the file should directly include a header file which properly intends to provide a declaration or definition of that symbol. It should not include header files for any other reason. 原始码档案和标头档所需的符号，都应该引入适当的标头档来提供宣告或定义； 不能因为其他理由而引入标头档。 Do not rely on transitive inclusions. This allows people to remove no-longer-needed #include statements from their headers without breaking clients. This also applies to related headers - foo.cc should include bar.h if it uses a symbol from it even if foo.h includes bar.h. 不可依赖过渡引入。开发者可以随时移除不需要的引入，又不会破坏客户端的相依性； 这也适用於相关的标头档：即使 foo.h 已经引入 bar.h，foo.cc 还是要引入 bar.h 。 ---- 想当然尔，动辄几百几千个原始码档和标头档 怎麽可能一个一个去分析 include 有没有写对？ 这就是这篇文章要介绍的工具了，名称也非常直觉 就叫做 include what you use 简称 iwyu。 https://include-what-you-use.org/ iwyu 是专门开发来对付这个问题的 它执行起来就像一个 gcc，会去分析原始码中所需的符号，并解析 include 档案 确定符号都是直接引入而不是过渡引入；同时还会帮忙产生修正档 一次完成引入的修正，简直是 include 的杀手级工具。 ---- iwyu 如果照文件的建议，是尽量搭配专案本来就有的 Makefile 或 CMake 使用 直接把 CC 或 CXX 代换成 include-what-you-use 加上 -k 编译 iwyu 就会输出编译档案 include 的修正档了 （加上 -k 是因为 iwyu 回报 include 错误会导致编译停止）； 使用 iwyu 时一定要让参数和真正编译时尽量相同 才能分析编译时使用的标头档和 -D 引入的巨集。 也有人会这样跑： find . -name "*.h" | xargs include-what-you-use <flags> find . -name "*.c" | xargs include-what-you-use <flags> 但要注意，直接对着 .h 使用 iwyu 可能会有问题 如果 .h 是公开有人使用的话，套用修正可能会把这个标头拆散 要使用者引入其他的标头档，这会破坏使用者的相依性， 特别是在大公司里面其他你管不到的专案可能会用你管的函式库，此时请小心使用。 ---- 依照 iwyu 文件的建议，使用 iwyu 所附的 fix_includes.py 套用修正： make -k 2> iwyu.out python fix_includes.py < iwyu.out 如此一来就完成 include 的修正。 虽然说我用完之後还是会遇到一些问题啦，像是出现这样的 include #include<data.h> #include"data.h" 或是还是有些原始码档案缺了一些符号必须自己手动补上 include 但整体来说已经比自己手动修正快上不少了 -- ______ |\ / \ | \ / ● ● \ |__\ / ______ \ | / 　 \__/ 　 \___| /______________\ | --

※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 220.134.248.249 (台湾) ※ 文章网址: https://webptt.com/cn.aspx?n=bbs/C_and_CPP/M.1604114190.A.1F0.html 问题不是这样的，假设你今天删了几行 code，里面有一行用到某个资料结构 像是 struct smartdata 好了，而且这是最後一个用到 smartdata 的地方 理论上，应该要去 include 的地方，把 #include<smartdata.h> 删掉 问题是有多少人会注意到这件事？就连 code review 都不一定会注意到了 又或者专案把 a.h 拆分成 a1.h a2.h 然後 a.h 里面 include a1.h/a2.h 其他专案会记得把所有 a.h 换成 a1.h 或 a2.h 吗？ coding standard 是目标，但无论多少教育/训练，在实行上就是会有疏失 "因为人就是会犯错，所以在铅笔的後面会有橡皮擦" 工具是用来辅助人，抓出人犯错的地方，而不是说人就不用教育/训练 ※ 编辑: lc85301 (220.134.248.249 台湾), 11/01/2020 17:16:48