使用appledoc自动生成api文档
AppleDoc可以根据项目中的注释自动生成类似于Apple官方文档的文档文件.
安装 appledoc
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh如果出现 INSTALL SUCCEEDED 则说明我们安装成功了。
使用方法
进入工程主目录,执行
appledoc --project-name "Your Project Name" --company-id "com.yourcommpany" --project-company "Your Company" ./这里省略了可以不添加的参数.如果有需要可以自己添加. 执行完成会在当前目录下生成一个docset-installed.txt的文件.这里是生成的docset存放地址.
集成到Xcode
新建一个target,类型为other中的Aggregate,将脚本添加到此target中,需要生成文档时,选择此target.平时build时不执行脚本.
也可以在当前的工程project下,打开build phrase,在Run Script下添加脚本.这样在bulid当前工程时就会执行脚本.
#appledoc Xcode script
# Start constants
company="abc";
companyID="com.abc";
companyURL="http://abc.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}"或者直接添加刚才在终端输入的命令也是可以的.
这样在build的时候,xcode会自动执行脚本,生成新的文档.
支持注释格式
经常使用的标签：
注意: 不管是直接使用终端还是集成到xcode,AppleDoc 使用的时候如果项目中有pod第三方的会报错。无法生成 docset-installed.txt和文档。 此时此时你可以 cd 到你项目的代码文件夹，再去执行脚本.
结果出现
并且生成 docset-installed.txt和文档.
Last updated