发现符号用法

Discovering Symbol Usage

本文关键字：用法 符号 发现      更新时间：2023-10-16

问题

我最近发现自己在处理一个庞大的、不熟悉的、多部门的C++代码库，需要更好的组织。我想找到一种方法来映射任何给定标头的源文件使用的符号。这是希望，如果只有一个部门使用给定的功能，那么它可以从共享区域移到该部门的区域。

尝试次数

我最初的想法是使用符号表：即编译项目并转储每个对象文件的符号。从那时起，我想我可以简单地写一个脚本来检查是否使用了头文件中的符号。虽然这种方法看起来是可行的，但它需要我从标题中创建一个符号列表。由于我的知识有限，我不确定如何自动化这样一个过程，而且有数百个头文件需要测试，手动完成是不可能的。

问题

  • 我的方法有效吗？如果是。。
    • 我可以使用什么从头文件中生成符号名称
  • 如果不是。。
    • 我还能做什么

此外，当我使用Linux时，大多数开发团队都在纯Windows环境中工作。我可以在两个平台上使用哪些实用程序？

我们非常感谢所有的帮助。

当我需要清理API时，我有时会使用来自callcatcher的信息。它基本上是在编译时构建一个所有符号的数据库，并允许您确定某些构建产品中使用的符号。

我有时也会使用DXR（github上的代码，一个示例安装）来浏览在哪里定义的代码以及如何使用。与DXR的callcatcher相比，您可以深入到更精细的细节。设置DXR是一项相当繁重的任务，但如果您有足够的代码可以使用，则可能是值得的。

另一方面，还有像cscope这样的工具。尽管它不能很好地与C++代码配合使用，但它仍然非常有用。如果你处理的是超过100kloc的夫妇，你会很快感到受到限制。

如果我只能选择其中一个工具，并且要在大型代码库（>1Mloc）上工作，我肯定会选择DXR。

您可以使用doxygen对所描述的信息有一个合理的开始。

即使对于不包含doxygen格式注释的源代码，创建的文档也可以包含使用特定符号的位置列表（即源文件）。

而且，由于doxygen可以用于生成html文档，因此在源代码树中导航变得微不足道。如果您启用dot功能为源树中的类生成关系图，效果会更好。

非常老派，简单，可能只是unix，但您知道etags吗？还有一个我认为与之类似的gnuglobal。

gnu全局链接指的是这里的"与类似工具的比较"讨论，这可能也很有用。

相关文章：