如何在Doxygen中重写类成员类型以生成正确的协作关系图
可行解决方案
以下两种方案都可以实现你的需求,可根据使用场景选择:
方案1:全局类型映射(无需修改业务代码,适配单实现场景)
直接修改Doxygen配置文件(Doxyfile)的预处理配置,让Doxygen在解析代码时自动把接口类替换为对应的实现类:
- 找到Doxyfile中的
PREDEFINED配置项,添加对应映射规则:
PREDEFINED += MyModuleIf=MyModule # 其他接口和实现的映射按相同格式追加即可,比如: # PREDEFINED += AnotherModuleIf=AnotherModule
- 确保Doxyfile中
ENABLE_PREPROCESSING = YES(默认状态为开启)。
这种方式Doxygen会在解析阶段直接把所有MyModuleIf类型识别为MyModule,生成的协作图会自动带出MyModule关联的YetAnotherModule,完全符合你需要的完整链路效果。
方案2:单成员局部标注(仅修改指定成员的解析类型,更灵活)
如果不需要全局替换,只想改SuperUser::myModule这一个成员的识别类型,可以用条件编译包裹成员定义,仅在Doxygen解析时暴露实现类型:
class SuperUser { /// @brief My special module #ifdef DOXYGEN MyModule &myModule; #else MyModuleIf &myModule; #endif };
之后在Doxyfile的PREDEFINED配置项中添加DOXYGEN=1即可,业务代码正常编译时还是使用接口类型,不影响原有逻辑,仅Doxygen生成文档时会识别为实现类,生成正确的关联关系。
补充说明
如果你的项目接口和实现的命名有统一规则(比如接口固定带If后缀,实现就是去掉后缀的名称),还可以写个简单的预处理脚本,配置到Doxyfile的FILTER_PATTERNS项,自动批量完成接口到实现的类型替换,不需要手动逐个加PREDEFINED规则。
内容的提问来源于stack exchange,提问作者Maciej Załucki
相关产品推荐
相关产品推荐

