大型多应用COM项目中Doxygen的最佳设置

Question

系统最多有100个VC ++项目，每个项目都会吐出一个DLL或EXE。此外，还有许多带IDL的COM组件和生成的.h / .c文件。

使用Doxygen组织这种方法的“正确方法”或至少是一种好方法？一个整体的doxy项目或每个项目/解决方案一个？什么是处理COM的正确方法，它产生了代码和大量“漏洞”，这会使生成的HTML文件膨胀。

Answer 1

我还没有机会尝试这个，但是doxygen能够link to external documentation。我可能会做单独的项目，并尝试使用外部链接。否则，对于您描述的大量项目，单个doxygen构建可能需要非常长的时间。

Answer 2

如果您不希望某些文件包含在Doxygen输出中，则可以使用EXCLUDE_PATTERNS指令。我工作的一个项目使用

EXCLUDE_PATTERNS = */test/*

避免在Doxygen输出中包含我们的单元测试类。如果您自动生成的COM文件具有任何类型的模式，则可以通过这种方式排除它们。

Answer 3

我选择了几个单独的doxygen构建如下：

• 为主应用程序构建顶级lib，不包括库
• 为每个库构建单独的“libs”文档
• 可选择使用所有内容构建“全局”doxygen构建
• 可选择在“内部”开关打开的情况下构建库。
• 所有输出都包含在一个Doxygen文件夹中（Doxygen\application，Doxyge\Lib1...）
• 使用顶级lib构建使用带有库函数链接的“主页”， 例如<a href="../_Lib1/html/index.html">Lib #1</a>
• libs有一个主页，其中包含一个返回顶级lib主页的链接： 例如href="../../_TopLevel/html/index.html"

不确定COM的东西......

史蒂夫