一、安装 appledoc 使用终端命令进行下载安装
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
成功后终端会输出:* INSTALL SUCCEEDED **
然后我们进行验证下:终端输入
appledoc --version
获取到版本号即表示成功了
*****如果安装没成功,有错误提示,最大可能是sudo没权限,需要切换到root账户下去获取权限,以下是一下相关的支持地址******
https://blog.csdn.net/maxsky/article/details/44905003
http://www.mamicode.com/info-detail-2405937.html
二、使用方法
使用终端cd到工程目录下
然后终端运行以下命令
appledoc --no-create-docset --output ~/doc --project-name "Your Project Name" --company-id "com.yourcommpany" --project-company "Your Company" ./
然后去设置添加脚本
脚本内容:
#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}"
然后直接运行工程
点击两个html都可以看到输出结果
我们如果想要导出这种格式,注释需要按照规定的来,我去查询的资料是支持一下三种注释格式:
1. /*! this a test . */
2. /** this a comment. */
3. /// this is a long comment. */