Link

首页

Tweet

书单

about me

Command

Category

Objective-C文档生成工具 appledoc


很多人习惯使用第三方的库,但是大部分库从github上下载后都只有代码文件,我们真正需要的API文档确无从下手。这里给大家介绍一款方便的文档生成工具appledoc

appledoc可以方便的生成和苹果官方文档风格一致的文档,并且会自动合并到你的XCode中。同时你也可以生成网页版的帮助文档。下面介绍一下软件的安装与使用。

由于appledoc是一款命令行工具,所以大家在使用的时候可能稍有不便,但是使用几次之后你会发现用起来非常简单。

安装 前提是你的mac中安装了git,执行下面的命令,即可将appledoc安装。

git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
使用
appledoc -o ./doc –project-name yourname –project-company yourcompany .
appledoc会扫描当前路径下的所有文件,然后生成好文档放到doc目录下。你也可以用appledoc –help查看所有可用的参数。

这里给出appledoc的官方文档 http://gentlebytes.com/appledoc/