Objective-C的文档生成器? [英] Documentation-generator for Objective-C?

查看:102
本文介绍了Objective-C的文档生成器?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

是否有一个通用的Objective-C文档生成器(类似于Ruby的RDoc)?我看过Doxygen和ObjcDoc,并且想知道哪个是最广泛使用的。

解决方案

Doxygen 可能是最广泛使用的选项。因为不仅仅是ObjC(Doxygen支持很多其他语言),所以开发活跃,社区相当强大。相比之下, HeaderDoc (现在是一个开源项目)似乎大部分停滞不前。 HeaderDoc只生成HTML输出,而Doxygen还生成除HTML之外的PDF,LaTeX和许多其他输出形式。即使苹果似乎推荐Doxygen,指南自动在Xcode构建过程中生成与Xcode帮助查看器兼容的文档集。值得注意的是,Doxygen可以读取HeaderDoc风格的注释,因此您可以用HeaderDoc样式编写文档,稍后决定是否使用Doxygen或HeaderDoc生成最终输出。


Is there a generally-accepted documentation generator for Objective-C (similar to RDoc for Ruby)? I've seen Doxygen and ObjcDoc, and am wondering which is most widely used.

解决方案

Doxygen is probably the most widely used option. Because it's not just for ObjC (Doxygen supports many other languages), the development is lively and the community quite strong. HeaderDoc (now an open source project), by comparison appears to have largely stagnated. HeaderDoc only produces HTML output, while Doxygen also produces PDF, LaTeX and many other output forms besides HTML. Even Apple seems to recommend Doxygen, with this guide to automatically producing documentation sets, compatible with Xcode's help viewer, from within your Xcode build process.

It's worth noting that Doxygen can read HeaderDoc-style comments, so you can write your documentation in HeaderDoc style and decide later whether to produce the final output using Doxygen or HeaderDoc.

这篇关于Objective-C的文档生成器?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆