appledoc工具的使用

之前较忙，有一阵子没写博客了，闲来无事最近在看iOS开发进阶这本书，虽然接触iOS也有一年多了，但对一些工具还是了解的比较少，所以最近主要针对工具这块学习的，共勉；

看了下appledoc（https://github.com/tomaz/appledoc），是一个从源代码中抽取文档的工具，类似于java自带的javadoc工具；

appledoc的优点如下：

a.它默认生成的文档风格和苹果官方的文档是一致；

b.appledoc是用objective－c写的，有利于调试；

      c.它可以生成docset，并且集成到Xcode；

      d.没有特殊的注释要求，兼容性高；

 安装

废话不多说，首先需要的是安装，安装很简单，只需要两步

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

自己用代码安装 /usr/local/bin这个目录本来就不存在，所以需要在appledoc目录下自己创建，如下

sudo mkdir -p /usr/local/bin
检查是否安装成功：

appledoc --version

如下图所示，表示安装成功：



也可以使用 appledoc --help 查看相关介绍；

使用

当安装成功后，切换到你所创建的iOS工程目录下，执行以下操作就可以了，appledoc会扫描当前路径下的所有文件，然后生成文档在你创建的doc目录下，

appledoc -o <output_path> --project-name <project_name> --project-company <project_company>例子如下：

appledoc -o ./doc --project-name
animation --project-company
weiyao .
doc为已经存在的文档，animation为工程名，weiyao .这个是公司名，不过随你写，注意那个小点前面有一个空格；
成功后会在你的工程目录下的doc文件下生成一个文档：如下所示：