iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)

时间:2023-01-19 12:18:48

Xcode自动注释插件------VVDocumenter规范注释生成器

  1.发现问题:

新开的项目需要先开发iOS版本,所以又把好久没写的iOS捡起来了,之前都是手动注释,最近是越来越懒了,所以在网上找了一个自动注释的插件.

  2.安装方法:

这里使用的是VVDocumenter-Xcode,地址是:https://github.com/onevcat/VVDocumenter-Xcode,下载压缩包,然后在Xcode工程里打开该项目,然后com+B,重启Xcode。

  3.用法:

然后就是随手打开一个你之前的项目,然后在任意一个方法上面连按三下"/"键盘,就会得到如下的效果了!

Objective-C效果图:
  iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)
 
Swift 效果图
iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)
 

  4.安装过程中出现的问题:

从Xcode 5开始,苹果要求加入UUID证书从而保证插件的稳定性。因此Xcode版本更新之后需要在VVDocumenter-Xcode的Info.plist文件中添加Xcode的UUID。
 
步骤如下:
 
一、查看Xcode的UUID
 
方式1
终端执行 defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID
iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)
拷贝选中的字符串。

方式2
在/Applications目录中找到Xcode.app,右键”显示包内容”,进入Contents 文件夹,双击Info.plist打开,找到DVTPlugInCompatibilityUUID,拷贝后面的字符串。
 
二、添加Xcode的UUID到VVDocumenter-Xcode的Info.plist文件
 
方式1--插件已经安装完成
1、打开 xcode插件所在的目录:~/Library/Application Support/Developer/Shared/Xcode/Plug-ins;
2、选择已经安装的插件例如VVDocumenter-Xcode,右键”显示包内容”;
3、找到info.plist 文件,找到DVTPlugInCompatibilityUUIDs的项目,添加一个Item,Value的值为之前Xcode的UUID,保存。
iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)

方式2--插件还未安装/重新安装
1、从GitHub克隆仓库到本地,在Xcode中打开项目,选择 项目名称,在TAGETS下选中VVDocumenter-Xcode;
2、选择Info,找到DVTPlugInCompatibilityUUIDs的项目,添加一个Item,Value的值为之前Xcode的UUID;
3、Build项目,VVDocumenter-Xcode会自动安装。
 
三、重启Xcode
Xcode 6之后,重启Xcode时会提示“Load bundle”、 “Skip Bundle”,这里必须选择“Load bundle”,不然插件无法使用。

问题二:

  5.安装说明:

1.Build成功后,可以在~/Library/Application Support/Developer/Shared/Xcode/Plug-ins目录下看到生成的xcplugin文件:

iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)

2.打开Xcode菜单,在Window选项下可以看到已经安装的插件:

iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)

 

点击打开,可以设置该插件的选项:

iOS插件详解之--Xcode自动注释插件之VVDocumenter规范注释生成器(2016.1.12王彬)