Xcoed 添加自定义docset文档

浏览: 177 发布日期: 2017-12-18 分类: objective-c

需要安装使用的工具 appledoc

安装方法(一):终端输入命令

 1. git clone git://github.com/tomaz/appledoc.git

 2.cd ./appledoc
 
 3.sudo sh install-appledoc.sh

安装方法(二): 终端输入命令 (条件:已安装过Homebrew)

 brew install appledoc

使用已安装的appledoc 生成 docset文件

终端 cd 到xcode所在的目录 输入命令:(YYY为想要生成文档的项目名

appledoc --project-name YYY --project-company General .

更新 保存注释文档

确认注释添加完后前往~/Library/Developer/Shared/Documentation/DocSets/ 目录将已生成好的 General.YYY.docset 上传到appleDoc模块根目录下

查看注释文档

查看方法(一):打开finder 点击前往文件夹,输入:~/Library/Developer/Shared/Documentation/DocSets/ 点击其中一个文件显示包文件 最后的Html 文件 可以打开在网页上浏览。

查看方法(二):或者用Dash 工具阅读也是很方便的。

查看方法(三):借助xcode的帮助文档查看。

返回顶部