Osheep

时光不回头,当下最重要。

安装和使用appledoc生成API文档

安装appledoc

使用终端下载:

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

直到出现这个画面说明安装成功

《安装和使用appledoc生成API文档》

image.png

使用appledoc

最方便的方法就是在xcode中添加script

新建target

《安装和使用appledoc生成API文档》

62671436F2C0F9E5E9CB0CC55D697839.jpg
《安装和使用appledoc生成API文档》

BB0387477B5B7C162A3B2FA3F1AA873E.jpg

通过我们新增加的Run Script
添加一下脚本

#appledoc Xcode script
# Start constants
company="RANY";
companyID="com.RANY";
companyURL="http://ranyeee.top";
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这里改一下API文档输出的路径
--output "~/desktop/doc" \ 
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}"

添加好script之后 run 一下这个target

《安装和使用appledoc生成API文档》

1B531CC204DD9FE98BA3156C140C0470.jpg

run 之后可以在output对应的目录下本地找到一个 html 文件

《安装和使用appledoc生成API文档》

C291A89EBD5B46AA8BE438197AB52976.jpg

打开html文件就能看到漂亮的文档了

《安装和使用appledoc生成API文档》

E401AA0F7A30924AD29893F1C1AAB364.jpg
点赞