[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档

[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档

 

 

Doxygen本来是一个很好的工具，可是我感觉在mac系统下，如果用doxygen最后生成的CHM文件感觉就不是那么恰当，应为本身CHM是微软的产品，苹果系统上并不是很通用，很经常出现文件乱码的情况。这时CHM就比不过PDF和RTF文件。其实直接的html文件也不错。

那在mac平台下没有什么其他的替代方法吗，肯定是有的。特地留意了一下，发现以前真是没有好好的使用xcode强大功能。

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。

其实还有很多高级的设置，可以支持用户定制格式等，还有支持Man page Generation Language（MPGL） Dialect，这里就不在展开了。具体可以参看苹果的官方的文档HeaderDoc user Guide