Objective-C的文档生成工具:appledoc

1. 安装命令

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

如果安装成功可以查看版本以及获取帮助

appledoc --version
appledoc --help

安装成功.png

2. 使用方法

1. cd 到当前目录下
2. name:项目名称
   company：公司名称

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

3. 第三步：集成进我们自己的工程

1、在你的工程中创建新的 Target，注意这里要选择 Other 中的 Aggregate，如图

Add Target.png

Aggregate.png

2、在我们新创建的 Target 中的 Buid Phases 中添加 Run Script，

Run Script.png

3、 打开Run Script，Shell 下面的文档区域添加这样的模板：

#appledoc Xcode script # Start constants company="ACME"; companyID="com.ACME";companyURL="http://ACME.com";target="iphoneos";#target="macosx";outputPath="~/help";# End constants/usr/local/bin/appledoc \--project-name "${PROJECT_NAME}" \--project-company "${company}" \--company-id "${companyID}" \--docset-atom-filename "${company}.atom" \--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \--docset-fallback-url "${companyURL}/${company}" \--output "${outputPath}" \--publish-docset \--docset-platform-family "${target}" \--logformat xcode \--keep-intermediate-files \--no-repeat-first-par \--no-warn-invalid-crossref \--exit-threshold 2 \"${PROJECT_DIR}"

4、Xcode 左上方选择这个 Target ，然后 Build 编译。
5、文档就会编译好并且自动安装进 Xcode 了（重启Xcode生效）。注意：这里我遇到了个稀里糊涂的坑，就是第一次编译的时候报错了，说我的第二行代码有了问题，之后我就将上述代码中的第二行去掉了，然后编译运行就 OK 了。之后写文章的时候我想重现这个bug，又将这句话加了回去，编译发现通过了，如果大家遇到了，就像我一样尝试去改一下，应该就没问题了，当然一次性编译通过最好。之后我重新拿一个项目试验了一下，第一次编译又报出了同样的错，之后又编译了一下就没问题了。坑。

坑图.png

6、那么编译之后我们就可以去查看它了，那么在哪里可以看到呢？这时我们就可以用之前生成的 docset-installed.txt文件啦，打开它：看到以一个 Path 了吧：直接复制，然后在 Finder 中前往文件夹：

文件目录.png 7、如果顺利的话我们就会看到这里啦：这个就是你生成的包文件，右键 --> 显示包内容你就会看到你的注释文件们啦，自己好好找喽。![Uploading 内容_278572.png . . .]

包文件.png

内容.png

作者：Mitchell链接：http://www.jianshu.com/p/f4c3bd04b887