swift - 将 Apple DocC 作为 Apple 帮助手册文件运行

Question

随着用于从源代码生成文档的 DocC 的引入，是否可以获取 DocC 的输出并将其用作 Apple 帮助手册（用于 macOS 应用程序内部）的真实来源？

• DocC介绍：https ://developer.apple.com/videos/play/wwdc2021/10166/
• 适用于 Mac 应用程序的 Apple 帮助手册：https ://developer.apple.com/library/archive/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html#//apple_ref/doc/uid/TP30000903-CH206-CIHEHEAC

标签： swiftmacosdocumentation-generationdocc

Answer 1

可能不是。它们是完全不同的动物。帮助手册是一个完整的网站，对某些类型的锚点有一些帮助。DocC 是一种非常特定类型的信息的高度受限、形式化的表示。确实，即使您将这两种东西融合在一起，您也不会想要；帮助手册帮助用户，而 DocC 向程序员显示编程 API。

举个例子，这是我写的一本帮助书：

http://www.aeth.com/sd5help/index.html

您不可能使用 DocC 来表达这一点。如果问题是您正在寻找一种工具来帮助您编写帮助书籍，那么 DocC 不是它。