添加Xcode自定义docset文档

一、生成docset文档

1.安装appledoc

  • appledoc是一个文档生成工具,只为Objective-C服务(很专一),能生成和Apple一个风格的文档,可以直接编译成docset安装进xcode。

  • 安装操作:终端输入

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

    2)cd ./appledoc

    3)sudo sh install-appledoc.sh

  • 或其它安装方式: brew install appledoc

2.使用appledoc生成docset文件

  • 进入code所在目录,执行以下命令 : appledoc --project-name XXX --project-company Lvmama . XXX 为想要生成文档的项目名。

  • 执行完毕默认会编译出docset并安装进Xcode,重启Xcode,点击Help -> Documentation and API Reference 打开查看。效果如图:

    这里写图片描述

    点击其中一个类进入(如BaseLineView):
    可以看到这个类包含的方法及其介绍,包括父类、描述、参数、返回值等
    这里写图片描述

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

二、更新使用docset文档

在appleDoc模块里有一个shell文件来执行遍历docset文件并copy到指定位置后删除原文件的命令:
这里写图片描述

所以使用时在终端输入(建议在Desktop目录下):

rm -rf appleDoc && git clone -b develop http://lvioscode.com/ios_support_tools/appleDoc.git && sh ./appleDoc/lvUpdateAppleDoc.sh

会自动将git上appleDoc模块现有的docset文档安装进Xcode,重启Xcode使用。

已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页