在Xcode中使用HeaderDoc生成注释和开发文档
使用Doxygen可以生成CHM文件,但在苹果系统中经常要出现乱码,因此我们在xcode中使用HeaderDoc工具来代替Doxygen,效果非常好。以下是xcode下HeaderDoc自动生成注释和开发文档的具体方法。
HeaderDoc工具
HeaderDoc是一个开源的工具,并且有集成在Xcode中,还有很强大的地方是你可以不用关心注释的格式,或者你可以定制注释的格式和解析的方法。
添加注释的方法是先选中需要添加的注释部分的代码,默认的函数写法需要在+/-号后面和函数名留一个空格。选中需要插入的对应类型的注释,添加说明,不用自己一个一个的写了。
Class header protocol都可以。

如果你知道怎么写脚本,甚至可以定制需要的的类型的注释,比如默认的没有property的注释,你可以自己写一个。也可以自定义快捷键,方便操作。

写好的了注释这就是需要生成可用的帮助文档了
生成文档的方法
用终端进入到头文件所在地文件夹,
》headerdoc2html –o outputDir ExampleHeaders
》gatherheaderdoc outpitDir TOC.Html
outputDir是保存html的文件夹名,ExampleHeaders是保存头文件的地方,TOC.Html是生成的文件名, 都是可以修改的。
运行完就可以在目录下找到TOC.Html,文件这样就可以有一份和Cocoa API Docments一样的文档。虽然还是Html。

HeaderDoc的具体用法大家可以参看苹果的官方的文档HeaderDoc user Guide,本文就介绍到这里了。
参考文章:http://blog.csdn.net/ssihc0/article/details/7240539
上一篇:总结Objective-C中CGGeometry几何类的常用方法
下一篇:图解Mac系统中搭建Titanium的iOS开发环境
