AppleDoc 的使用
2016-08-02 18:39
218 查看
AppleDoc 的使用
AppleDoc 的使用AppleDoc 简介与安装
配置方式
进入程序目录
点击工程 Editor AddTarget Other Aggregate 如图
添加RunScript如图
重启Xcode
AppleDoc 简介与安装
appledoc是一个可以帮你生成Objective-C代码注释的辅助工具,appledoc所生成的注释API文档与苹果类库的API文档保持一致.这可以让Xcode能够识别出我们自己的API文档.
git clone git://github.com/tomaz/appledoc.git
当看见这句话的时候就说明已经在下载了 Cloning into ‘appledoc’…
进入目录
cd ./appledoc
安装appledoc
sudo sh install-appledoc.sh
查看版本(验证是否安装成功)
appledoc --version
安装成功后如上appledoc version: 2.2.1 (build 1334)
配置方式
进入程序目录
cd /Users/guo/Desktop/demo2
运行命令,demo2 为工程名字 guo为公司名或个人名
appledoc --project-name demo2 --project-company guo ./
运行成功后工程文件夹的根目录多了这个文件
docset-installed.txt
点击工程 -Editor -AddTarget -Other -Aggregate 如图
Next -名称随便添写,创建好后如图
添加RunScript如图
添加脚本 参数改成要自己的如图
脚本代码如下
#appledoc Xcode script # Start constants company="guo"; companyID="com.guoziui.fuck"; companyURL="/Users/guo/Library/Developer/Shared/Documentation/DocSets/"; 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}"
Build一下 ( command + B )
重启Xcode
以后写的注视就都能在 源文档中查看了相关文章推荐
- Android Manifest 用法
- 什么是 GraphQL?
- Spark RDD API详解(一) Map和Reduce
- Spring Boot 开发微服务
- lwn拾遗:[sn3218 led drivers]-api解释-1
- 页面元素查找之Selectors API
- 苹果与Siri的七年之痒:“宫斗”戏码不断上演
- 央视新闻报道XcodeGhost事件
- ie6 注释引起的问题
- 一个小型js框架myJSFrame附API使用帮助
- 编写Ruby代码注释时需要注意的一些问题
- Ruby教程之注释、变量声明以及数组操作
- 详细分析交换机、路由器、集线器的区别和联系
- PowerShell打开或关闭光驱
- 批处理的api WMIC学习体会有感第1/2页
- 批处理 API实现文件下载的代码第1/2页
- Lua教程(十七):C API简介
- 强制删除工具 xdelbox xdelbox1.5正式版下载
- 揪出交换机端口背后“凶手”导致网速太慢
- 电脑重启后突然检测不到硬盘的原因分析与解决办法