陈斌彬的技术博客

Stay foolish,stay hungry

Objective-C 文档生成工具-appledoc

iOS 开发的过程中少不了要做项目文档。文档生成工具有3种,docxygen,headerdo,appledoc。这里主要介绍如何使用苹果官方文档风格的 appledoc 工具。

安装 appledoc

方法一:

执行命令:

 git clone git://github.com/tomaz/appledoc.git
 cd appledoc
 sudo sh install-appledoc.sh

方法二:

brew install appledoc

这里我自己用到的是方法一。方法二前提是要先安装 Homebrew

验证是否安装:

appledoc --version

结果显示:

appledoc version: 2.2.1 (build 1333)

使用

只需要执行命令:

appledoc -o ./doc --project-name hxxy --project-company hx .

注意:最后的 号不能漏掉,我就是这么大意给忘了。 appledoc 会扫描当前路径下的所有文件,然后生成好文档放到doc目录下。可以用appledoc —help查看所有可用 的参数。如下图:

img

编译出的Docset默认会放在~/Library/Developer/Shared/Documentation/DocSets路径下。 Docset格式,实际上是一个bundle,里面包含了一些xmlhtml。显示包内容后就可以查看和修改了。如果需要放到网站上,那单独将html部分取出来就行。 img 右键点击显示包内容,找到Documents目录,打开后就可以看到 appledoc 。

img