Objective-C的文档生成器?

时间:2009-05-01 22:15:52

标签: objective-c documentation

是否有一个普遍接受的Objective-C文档生成器(类似于RDoc for Ruby)?我见过Doxygen和ObjcDoc,我想知道哪个是最广泛使用的。

6 个答案:

答案 0 :(得分:54)

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

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

答案 1 :(得分:43)

结帐appledoc。它基于Doxygen。您可以看到它吃自己的狗粮,因为它会为appledoc reference documentation生成appledoc source code。例如,比较GBComment.hGBComment Class Reference

另外,请查看Xcode's Documentation Set Guide以获取有关如何创建适用于Xcode的文档的全面说明。这些是appledoc自动化的说明。

答案 2 :(得分:6)

Doxygen被广泛使用。我似乎也每周一次使用它作为SO答案。

答案 3 :(得分:5)

Realm的新工具是Jazzy,它以新的Xcode 6样式生成文档,并支持生成Swift文档(以及Objective-C)。

答案 4 :(得分:4)

除了doxygen,苹果还有一个开发工具附带的工具。它会生成您在SystenConfiguration框架之类的内容中看到的文档类型。该工具名为HeaderDoc,文档可在HeaderDoc User Guide

中找到

答案 5 :(得分:0)

也许你应该jazzy尝试Realm。它是一个开源项目。 jazzy支持Objective-C&迅速。

"输出与Apple官方参考文档的外观相符,发布于WWDC 2014。"你可以从它提供的sample doc来判断。