iOS借助AppleDoc 生成Api文档

如果MAC上还未安装AppleDoc可以通过终端命令进行下载安装

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

如果出现 ** INSTALL SUCCEEDED **则说明我们安装成功了。

使用方法

第一步：使用终端进入项目目录：
第二步：

appledoc --no-create-docset --output ~/doc --project-name "docTarget" --company-id "com.Auko" --project-company "Auko" ./

其中'~/doc'是我设置的存放路径
其中'docTarget'是我这个用于生成文档的工程名
其中'com.Auko'是公司ID
其中'Auko'是公司名称

这只是其中一种简单的写法, 想了解全部参数, 可以通过appledoc –help查阅

回车后就会显示一大堆信息

appledoc version: 2.2.1 (build 1334)
...

如果没什么错误 ,一般就可以生成一个html的文件夹, 里面就是生成的Api文档了