Xcode配置Appledoc并生成项目文档

安装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生成文档

1. 创建一个项目HelloWorld。
2. 点击项目设置然后添加Target如图
   
3. 弹出框选择Aggregate模板
   
4. 输入Target名称为Document
   
5. 添加Phase的类型为 Add Run Script
   
6. 拷贝官网的代码到Run Script中
   

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

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

7. 在.m文件中写入自己的注释
   
8. 生成文档
   
9. 成功后查看生成的文档