c++ - 提取头文件中的函数列表

Question

我正在寻找一种方法来提取在 C++ 头文件中找到的所有函数，包括位于函数定义顶部的相应函数的注释。

想法是生成文件中所有函数的列表，以便将其放入 CSV 或 Excel 文件中。我想在每一行:

头文件名；只有函数名；完整的函数签名；该函数代码中的注释

示例(来自文件 someHeader.h):

// This is the multi-line
// comment for the DoSomething function.
void            DoSomething (int CleverParameter);

变成了

someHeader.h;DoSomething;void DoSomething (int CleverParameter);This is the multi-line comment for the DoSomething function.

我不需要聪明的解析和类型/依赖解析或类似的东西。我手头有 VisualStudio 2010 和 2012。也不怕 Linux 或 Windows 命令行工具。如果空白在此过程中得到清理，那就太好了。

Answer 1

编写像样的 C++ 解析器不是一件容易的事。

一个可能的解决方案是使用文档生成器，例如 doxygen's ，它不包括完整的 C++ 解析器，但它应该足以满足您的目的:

• 使用 doxygen 生成包含所有函数定义和注释的 XML 输出
• 使用 XSLT 样式表或 XML 解析器生成 CSV 文件

这不是完美的解决方案，但它肯定比正则表达式方法更健壮，并且不需要大量代码即可运行。