Objective-C的文档生成器？

Question

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

Answer 1

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

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

Answer 2

查看appledoc.它基于Doxygen.您可以看到它吃自己的狗食,因为它生成了appledoc源代码的appledoc参考文档.比较,例如,到类参考.GBComment.hGBComment

• appledoc:如何写评论
• appledoc命令行设置示例

另外,请查看Xcode的文档集指南,了解有关如何创建与Xcode一起使用的文档的全面说明.这些是appledoc自动化的说明.

Answer 3

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

Answer 4

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