安装Appledoc
首先说下Appledoc的地址 https://github.com/tomaz/appledoc 这里有Appledoc的最新信息。
安装Appledoc很简单
1
|
git clone git:
//github
.com
/tomaz/appledoc
.git
|
把该程序clone到本地,然后进入程序根目录。执行安装sh
1
|
sudo
sh
install
-appledoc.sh
|
配置Xcode生成文档
- 创建一个项目HelloWorld。
- 点击项目设置然后添加Target如图
- 弹出框选择Aggregate模板
- 输入Target名称为Document
- 添加Phase的类型为 Add Run Script
- 拷贝官网的代码到Run Script中
1234567891011121314151617181920212223242526#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}"
- 在.m文件中写入自己的注释
- 生成文档
- 成功后查看生成的文档