iOS 生成开发文档

2015 继续努力

有3种方式生成开发文档：介绍其中一种利用 appledoc 生成

一、安装appledoc

打开终端在命令行里面：

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

cd ./appledoc

sudo sh install-appledoc.sh

 

安装完成后，验证一下OK了没:

appledoc --version

 

二、使用appledoc

进入code所在目录，跑一下下面的命令，默认会编译出docset并安装进Xcode。（进入code所在目录：cd 把相关文件夹拖进来就可以了）

写入以下命令就可以生成该project的开发文档：

appledoc --project-name MyProject --project-company ibireme ./

可以打开xcode －－window－－Documentand....看到生成的开发文档

Myproject 是项目名字 

可以appledoc －－help 查阅关于appledoc的帮助

 

 链接：

相关帮助：http://blog.ibireme.com/2013/08/26/appledoc-guide/