如何配置Swift-DocC编译以排除不必要的文件与路径?
解决Xcode编译DocC文档时排除依赖框架的问题
1. 是否可以配置排除不必要的文件/路径?
可以。Xcode 15提供了明确的配置方式,能够限制DocC仅编译目标框架的文档,排除依赖框架的处理流程。
2. 具体配置步骤
方法一:通过Scheme编辑限制编译目标
- 打开框架A对应的Scheme编辑界面:点击Xcode顶部菜单栏「Product」→「Scheme」→「Edit Scheme」(或快捷键
⌘ <)。 - 在Scheme编辑窗口左侧,切换到「Build Documentation」选项卡。
- 在右侧「Targets」列表中,仅保留框架A的目标,右键点击依赖框架(如Realm)的条目选择「Remove」移除。
- 点击「Close」保存配置,重新执行「Build Documentation」操作。
方法二:通过Build Settings添加DocC编译参数
如果依赖是通过Swift Package Manager自动引入,方法一无法完全排除时,可通过自定义参数实现:
- 在项目导航栏选中框架A目标,切换到「Build Settings」标签页。
- 搜索「OTHER_DOCC_FLAGS」(Documentation Compiler - Custom Flags)。
- 双击编辑区域,添加以下参数:
若有多个依赖,可添加多个--exclude-module Realm--exclude-module 模块名参数,替换为对应依赖的模块名称。 - 保存设置后重新编译文档。
额外检查点
若日志仍显示依赖框架被处理,可查看框架A的Build Phases,确认是否包含了依赖框架的DocC目录引用,如有则移除对应条目。
内容的提问来源于stack exchange,提问作者devshok
相关产品推荐
相关产品推荐

