Objective-C的文档生成器？

Question

Objective-C是否有一个公认的文档生成器（类似于Ruby的RDoc）？我见过Doxygen和ObjcDoc，并且想知道哪个应用最广泛。

Answer 1

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

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

Answer 2

Doxygen应用非常广泛。我似乎也将它用作每周一次的SO回答。

Answer 3

除了doxygen，苹果还有一个工具随附的开发工具。它会生成你在类似SystenConfiguration框架的东西上看到的文档类型。该工具称为HeaderDoc，文档可在HeaderDoc User Guide中找到。

Answer 4

结帐appledoc。它基于Doxygen。你可以看到它吃它自己的狗食，因为它产生appledoc source code的appledoc reference documentation。例如，比较GBComment.h到GBComment Class Reference。

• appledoc: how to write comments
• appledoc examples of command line settings

此外，看一看Xcode's Documentation Set Guide关于如何创建文档，与Xcode中工作的全面说明。这些是appledoc自动执行的说明。

Answer 5

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

Answer 6

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

“输出与苹果官方参考文档的外观相匹配，在WWDC 2014之后。”你可以从它提供的sample doc来判断。