如何在Apple DocC中为String等系统类型扩展生成文档
DocC系统类型扩展无法自动生成文档问题解答
这是Apple DocC的默认行为,不属于配置遗漏。
底层逻辑说明
- DocC默认仅会自动收录当前模块内自定义类型的扩展文档,你示例中自定义的
MyStruct属于当前模块的原生类型,因此扩展可以正常生成文档 - String、Date这类属于外部系统框架(如Foundation)的类型,其扩展默认会被DocC过滤,避免文档中混入大量非当前模块原生定义的类型内容,导致文档结构臃肿混乱
手动收录系统类型扩展的方案
如果需要将系统类型的扩展也纳入DocC文档,可通过手动配置文档目录实现:
- 若项目还没有DocC目录,在Xcode中新建
Documentation Catalog生成对应的.docc文档目录 - 在.docc目录下新建自定义Markdown文档,在文档中通过DocC的引用语法关联目标系统类型及扩展方法,示例写法如下:
# ``Foundation/String`` ## 自定义方法 - ``myMethod()``
- 重新执行DocC构建操作,即可在生成的文档中看到对应系统类型的扩展内容。
内容的提问来源于stack exchange,提问作者PJR
相关产品推荐
相关产品推荐

