【iOS】objective-c 文档生成工具 appledoc

最近做ios framework的一些测试，提供给其他开发者使用的framework，API文档变得更加重要，以前没有接触过，这次尝试使用了一把appledoc来生成一下文档，感觉还不错。

首先，是从这个哥们儿的文章里面发现大家推荐使用appledoc http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/

下面介绍一下appledoc的基本使用。

1 — 安装

git clone git://github.com/tomaz/appledoc.git 

cd appledoc 

sudo sh install-appledoc.sh

 

友情提示：

可能会有安装不成功的情况，我遇到的是 /usr/local/bin这个目录不存在。建好bin这个文件目录就可以了，进入到 /usr/local目录，sudo mkdir bin。

其他问题见招拆招就好 ^-^。

 

测试是否安装成功：appledoc --help

 

2 — 生成文档

进入到你的目标工程所在目录，尝试执行以下命令：

appledoc

--project-name DemoForMe 

--project-company siying 

--output ~/Desktop/docs 

--keep-intermediate-files ./DemoForMe  

 

各项参数说明：

DemoForMe：工程名称

siying：公司名称

~/Desktop/docs 生成的文档要存放的目录

./DemoForMe ：源文件所在目录

 

在docs目录下面就可以生成如下的结果：

 

有xcode的时候，如果不指定--keep-intermediate-files，appledoc会将中间生成的htmls和docset删除掉。

如果只需要在xcode中查看，就不需要指定这个参数。

 

生成出来的docs可以直接导入到xcode中，使用还是很方便的。

最后说明：要使用appledoc生成漂亮的文档，前提是要按照规范写好各种注释。