如何在 Apple DocC 上添加字符串扩展

【问题标题】：How to add String Extension on Apple DocC如何在 Apple DocC 上添加字符串扩展
【发布时间】：2021-08-31 10:08:45
【问题描述】：

我正在Xcode 13 beta 上查看新的 Apple 文档。我可以build documentation DocC。

但我无法看到为字符串扩展、日期扩展等扩展创建的任何文档。

按照下面的例子，它不会添加任何文档。

extension String {

    /// Description for DocC
    func myMethod() {
       
    }
}

考虑一下，如果我为任何结构或类创建了扩展，那么它正在添加如下代码的文档

public struct MyStruct {

}


extension MyStruct {

  /// Description
  func myMethod() {
 
  }
}

这是苹果的默认行为还是我遗漏了什么？

【问题讨论】：

【解决方案1】：

目前不支持此功能。 DocC 不能为除了单个模块的类型之外的任何东西生成文档。不处理对模块外部类型的扩展。（它也不允许您使用 ``...`` 引用链接到模块外部的类型。）

【讨论】：

感谢罗布·纳皮尔。这是 XCode 测试版的限制吗？您是否有上述场景提到的任何特定文档链接？
这是测试版的一个限制，但没有迹象表明它会在发布时进行改进（Apple 很少在发布之前宣布他们计划改进的内容，所以它可能会）。我知道没有官方的 DocC 限制列表（它将在今年晚些时候开源，但还没有）。但这不起作用，描述的相关用例也不起作用。符号仅相对于当前模块进行解析。当 360iDev 演讲发表时，Ellen Shapiro 对此进行了精彩的演讲。 speakerdeck.com/designatednerd/…
请注意，这甚至适用于包含多个模块的 Swift PM 包。您根本无法链接到当前模块之外，即使在同一个 SPM 包中也是如此。这就是 v1.0 的本质。