AppleDoc------------使用xcode导出api文档

众所周知，程序员最讨厌的两件事：1、接手的项目没有注释2、给自己的项目添加注释。一般一个项目上线后，公司都要求项目代码进行详细注释和到处文档，然后才封版，所以就用到了今天我整理的这篇文章，使用appledoc自动生成项目文档。

appdoc的使用有一个前提，注释要符合标准，值得庆幸的是Xcode8之后，Xcode已经集成了注释插件，点击command+option+/即可，此处不做过多介绍，效果如下：

安装appledoc

git clone git://github.com/tomaz/appledoc.git

cd ./appledoc

sudo sh install-appledoc.sh

安装完成之后，验证一下是否安装成功

appledoc --version

生成文档

生成文档有两种方法：

一、使用终端命令生成：

appledoc --project-name 工程名称 --project-company 公司名称 ./

二、使用targets集成到项目中：

脚本文件如下：

#appledoc Xcode script

# Start constants

company="公司名称";

companyID="com.公司id";

companyURL="http://公司网址";

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}"