appleDoc 使用

1、先把appledoc 从github上克隆下来,地址 :https://github.com/tomaz/appledoc

2、cd 到文件中 安装 appledoc

sudo sh install-appledoc.sh

输入mac密码,进入安装

3、验证是否安装成功

appledoc --version

如果出现

appledoc version: 2.2.1 (build 1334)

则为安装成功。

4、cd 到工程文件夹下,输入

appledoc -o ./doc -p SHBFanyi -c com.shenhongbang.cnblogs -i Pods .

-o:输入路径

-p:工程名称

-c:工程id

-i:忽略的文件

<可以输入 appledoc --help 查看更多操作>

出现下图则为成功

在工程根目录里有个doc 文件夹,打开里面的 docset-installed.txt 文件,打开路径,出现如图

 

 

打开包内容-->Contents-->Resoures-->Documents,这里就是文档了

posted @ 2016-04-18 17:05  沈红榜  阅读(196)  评论(0编辑  收藏  举报