【iOS工具】注释插件 VVDocumenter-Xcode 的安装使用及误点击“Skip Bundle”的解决办法！...-白红宇

一、前言

VVDocumenter-Xcode 注释插件是由 @onevcat 大神开发的一个Xcode注释插件，其作用是在Xcode中输入 "///" 后自动生成规范的文档注释，超级强大实用！！！

VVDocumenter-Xcode 插件下载地址：

截图 01

二、VVDocumenter-Xcode 安装

1、先去 github 下载该插件，并解压；

2、点击解压文件夹中的 VVDocumenter-Xcode.xcodeproj 文件，用 Xcode 进行打开；

截图 02

3、编译运行完成之后，完全退出 Xcode（ command+q ）；

4、再次打开 Xcode 会弹出一个提示框，两个选项，“Load Bundle” 和 “Skip Bundle”，一定要选择 “左侧” 的 “Load Bundle” 进行加载安装，之后就可以正常使用；一定不要手残习惯点击右侧的 “Skip Bundle” 跳过加载安装，插件会安装无效，不能使用，需要进行一些操作才能解决。

截图 03

5、安装成功后，在 Xcode --> Window 窗口中可以找到插件 VVDocumenter 即说明已经安装成功了！

截图 04

三、VVDocumenter-Xcode 使用

1、在 Xcode 中的方法名前面或者是在空白处输入 “///” 则会自动产生代码注释规范，如下图：

截图 05

四、安装过程中点击 “Skip Bundle” 后插件失效的解决办法

有时可能因为用户习惯的原因，习惯去默认点击弹框右侧的选项，而造成的插件失效，并且重新安装时却不会再次弹出该弹框而困扰，小编之前就因为手残点击过，还是需要花一些时间去解决的。解决步骤：

1、Xcode7之后需要先获取 Xcode 应用的 UUID 才可以正常使用，可以通过在终端中输入下面的命令即可获取。记住是 Xcode 的 UUID，不是 MAC 电脑的 UUID；且当电脑中装有多个版本的 Xcode 时，记得在终端中输入的命令有所改变；

【 Xcode.app 应用的 UUID 】defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID

【 Xcode 2.app 应用的 UUID 】defaults read /Applications/Xcode\ 2.app/Contents/Info DVTPlugInCompatibilityUUID

【 MAC 电脑的 UUID 】ioreg -d2 -c IOPlatformExpertDevice

截图 06

2、需要将之前编译安装的文件进行清除，需要在两个地方进行清除：

第一个：Finder -->前往 --> 前往文件夹 --> 输入：~/Library/Application Support/Developer/Shared/Xcode/Plug-ins ；将该目录下的 VVDocumenter-Xcode.xcplugin 文件删除掉；

截图 07

第二个：找到注释插件文件夹，右击 VVDocumenter-Xcode.xcodeproj 文件，选择 “显示包内容”，将 “xcuserdata” 文件夹下的与自己电脑关了的数据文件夹删除掉；

截图 08

截图 09

3、删除这两个文件后，用Xcode打开下载的插件里的文件，找到 VVDocumenter-Xcode/Supporting Files/VVDocumenter-Xcode-Info.plist；在 DVTPlugInCompatibilityUUIDs 文件中添加自己之前通过终端获取的 Xcode 应用的 UUID；

截图 10

4、当这些设置完成之后，再次编译运行，之后完全退出 Xcode （ command+q ）；再次打开 Xcode 时就会重新弹出一个选择框，记住，这次一定要选择 “Load Bundle” 选项，否则又要重复这些步骤了，切记，切记！！！

截图 03

五、Xcode 8 使用的情况

1、这前面写的都是在 Xcode 8 之前的 Xcode 7 环境下的情况，在 Xcode 8 的环境下，由于苹果 Xcode 自己集成了该方法，可以通过快捷键进行显示：

快捷键：option + command + /

2、这样的话就不需要使用 VVDocumenter 插件了，不过还是要感谢 @onevcat 大神为 iOS 开发做出的贡献！！！