Objective-C 的文档生成器？ [关闭]答案

【问题标题】：Documentation-generator for Objective-C? [closed]Objective-C 的文档生成器？ [关闭]
【发布时间】：2010-10-23 05:56:46
【问题描述】：

是否有普遍接受的 Objective-C 文档生成器（类似于 Ruby 的 RDoc）？我看过 Doxygen 和 ObjcDoc，我想知道哪个使用最广泛。

【问题讨论】：

标签： objective-c documentation

【解决方案1】：

Doxygen 可能是使用最广泛的选项。因为它不仅仅适用于 ObjC（doxygen 支持许多其他语言），所以开发很活跃，社区也很强大。相比之下，HeaderDoc（现在是一个开源项目）似乎基本停滞不前。 HeaderDoc 只产生 HTML 输出，而 doxygen 也产生 PDF、LaTeX 和除 HTML 之外的许多其他输出形式。甚至 Apple 似乎也推荐使用 doxygen，通过 this 指南自动生成与 Xcode 的帮助查看器兼容的文档集，从您的 Xcode 构建过程中。

值得注意的是，doxygen 可以读取 HeaderDoc 样式的 cmets，因此您可以使用 HeaderDoc 样式编写文档，然后再决定是使用 doxygen 还是 HeaderDoc 生成最终输出。

【讨论】：

UPDATE: appledoc 是新的和改进的解决方案。 “[它] 使用 doxygen 作为从源文件中提取文档的基础，然后将 doxygen 输出转换为更好看的布局。”
appledoc 是有问题的 - 它要求您在您的文档或您的网站中将其归因于您使用 appledoc。从什么时候开始格式化程序需要归属？！？

【解决方案2】：

查看appledoc。它基于Doxygen。您可以看到它吃自己的狗粮，因为它为appledoc source code 生成appledoc reference documentation。例如，比较 GBComment.h 和 GBComment Class Reference。

此外，请查看Xcode's Documentation Set Guide，了解有关如何创建适用于 Xcode 的文档的全面说明。这些是 appledoc 自动执行的指令。

【讨论】：

我们最近从 Doxygen 切换到 Appledoc，到目前为止我很高兴。 IMO 最好的一点是，快速弹出帮助气泡（选项单击）与您从 Apple 文档中获得的所有信息相同。 Doxygen 生成的文档集没有正确的结构，无法被它们拾取。
评论您链接的两个指南已移至here for writing comments 和here for examples of command line settings。
注意：Appledoc 2 不再基于 Doxygen

【解决方案3】：

Doxygen 的使用非常广泛。我似乎也将其用作 SO 答案，大约每周一次。

【讨论】：

【解决方案4】：

Realm 的一个新工具是Jazzy，它以新的 Xcode 6 样式生成文档，并支持生成 Swift 文档（以及 Objective-C）。

【讨论】：

无法从 Swift 类生成 Objective C 和 Swift 文档，这是一个主要缺点。

【解决方案5】：

除了 doxygen，苹果还有一个工具，它是开发工具自带的。它会生成您在 SystenConfiguration 框架等方面看到的文档类型。该工具名为 HeaderDoc，文档可在 HeaderDoc User Guide 中找到。

【讨论】：

HeaderDoc 开发相当停滞。 Doxygen 是一个更好的选择。使用适当的附加组件，如果您愿意，可以使 Doxygen 输出看起来与 HeaderDoc 非常相似。
停滞与否，它是为 Objective-C/C/C++ 生成文档的有效选项。我个人讨厌 Doxygen 生成的文档。
是的，这就是我要找的！如果在 Mac 上使用 Xcode 进行编码，为什么不使用 Apple 使用的东西呢？

【解决方案6】：

也许您应该通过Realm 尝试jazzy。这是一个开源项目。 jazzy 支持 Objective-C 和 Swift。

“输出与 WWDC 2014 后 Apple 官方参考文档的外观和感觉相匹配。”你可以从它提供的sample doc来判断。

【讨论】：