Objective-C的文档生成器?
是否有一个公认的Objective-C的文档生成器(类似于Ruby的RDoc)? 我见过Doxygen和ObjcDoc,我想知道哪个应用最广泛。
Doxygen可能是使用最广泛的select。 因为它不仅仅是为了ObjC(Doxygen支持许多其他语言),所以开发活跃,社区相当强大。 HeaderDoc (现在是一个开源项目)相比之下似乎已经停滞不前。 HeaderDoc只生成HTML输出,而Doxygen除了HTML之外还生成PDF,LaTeX和其他许多输出格式。 即使苹果似乎也推荐Doxygen, 本指南自Xcode构build过程中自动生成与Xcode的帮助查看器兼容的文档集。
值得注意的是Doxygen可以读取HeaderDoc风格的注释,所以你可以用HeaderDoc风格编写你的文档,然后决定是否使用Doxygen或HeaderDoc产生最终的输出。
检查出appledoc 。 它基于Doxygen 。 你可以看到它吃它自己的狗食,因为它生成了appledoc源代码的appledoc参考文档 。 例如,将GBComment.h
与GBComment
类参考进行比较 。
- appledoc:如何写评论
- 命令行设置的appledoc示例
另外,请参阅Xcode的文档集指南 ,了解如何创build与Xcode一起使用的文档的全面说明。 这些是appledoc自动执行的指令。
Doxygen使用非常广泛。 我似乎也用它作为每周一次的SO回答。
一个新的工具是Realm的Jazzy ,它以新的Xcode 6风格生成文档,并支持生成Swift文档(以及Objective-C)。
除了doxygen之外,苹果还有一个工具来配合开发工具。 它会生成你在SystenConfiguration框架中看到的文档types。 该工具被称为HeaderDoc文档可以在HeaderDoc用户指南中find 。
也许你应该尝试一下Realm的 爵士乐 。 这是一个开源项目。 jazzy
支持Objective-C和Swift。
“产出与WWDC 2014之后苹果官方参考文档的外观相匹配。” 您可以从它提供的示例文档中进行判断。