Objective-C 和 Swift 文档一起，就像苹果文档一样。

Question

我目前正在构建iOS SDK，使用Objective-C编写。现在我已经测试并准备好了SDK，想要添加文档，结合Swift和Objective-C。我已经使用以下文档生成器工具：

a. Doxygen

b. AppleDoc

c. Jazzy

d. Apple的HeaderDoc。

我想使用我的Objective-C头文件中的注释，生成类似于Apple最近所做的Objective C和Swift的组合帮助文档。我的问题是如何从Objective-C头文件生成Swift和Objective-C的文档？ 这是一些基于我的研究的链接：

• https://github.com/realm/jazzy/issues/353
• https://github.com/jpsim/SourceKitten/pull/95

谢谢您，

Ram。

请参考此处的苹果文档：

- Ram

---

不太清楚你的问题。你想使用Obj-c和Swift构建一个应用程序？那个关于文档的部分是什么意思？你所说的“支持Obj-c和Swift”是什么意思？目标是iOS。它支持两者。这就是整个问题的全部内容。 - NSNoob

如果你想在Swift项目中使用Obj-C文件，那么你应该阅读这篇文章。https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html。这是可能的。 - NSNoob

感谢您的快速回复。我想生成类似于苹果文档API的doc sets，其中包括Swift和Objective-C的文档。请参考这里。 - Ram

@NSNoob 让问题更清晰了。 - Ram

Ram是正确的 - 这对于例如托管在CocoaPods中的Objective-C库的自动生成文档非常有趣。对于本地文档也非常有趣。在未来的几年中，我们将拥有受益于这种组合文档的Objective-C和Swift混合体。 - ThorstenC

问题非常清晰。他想使用一些工具生成文档（创建docset），这些工具将以苹果相同的方式格式化docset。在官方苹果文档中，用于swift和OBJ-C的代码都有所体现，您可以获取swift和/或obj-c的文档。我寻找了同类型的工具，因为我的项目是混合项目，并且使用2个不同的工具来为obj-c部分和swift部分生成docset，最终得到2个docset很麻烦。可惜我没有看到只做这件事情的工具。想知道苹果是如何做到这一点的？ - Pascale Beaulac

Answer 1

也许目前不完全符合您的要求，但是您可以使用Swiftify（https://objectivec2swift.com/）服务将Objective-C声明转换为Swift。另外，如果以上文档工具允许开发任何插件进行集成，则可以使用我们的Web API自动生成Swift源代码。如果有需求的话，我们可能会愿意开发这样的集成。免责声明：我是Swiftify的作者 :)

- Crulex

---

感谢您宝贵的回复。我尝试了Swiftify。它可以完美地将Objective-C代码转换为Swift，但无法转换代码的文档。然而，正如您所提到的，如果有需求，我会积极等待这个功能的推出。 - Ram