VVDocumenter-Xcode安装及遇到问题解决方案

时间:2022-11-03 07:13:55
1.VVDocumenter-Xcode.xcplugin插件的安装
在程序开发中,我们免不了要写许多注释,方便帮别人也方便我们自己以后检查我们的代码。然而,写注释是一件十分浪费我们时间与精力的事,要写符合文档格式的注释,更是会消耗我们很多的功夫,幸运的是,VVDocumenter可以帮我们很大的忙。
        gitHub地址:https://github.com/onevcat/VVDocumenter-Xcode
安装与使用方法:下载github源码,使用xcode打开工程,运行一下,如果成功,插件就安装好了,这时,我们必须将xcode重新启动一下,重启Xcode选择任意一个项目时,会弹出下图,注意必须点Load Bundle 下载才可以使用。 VVDocumenter-Xcode安装及遇到问题解决方案 接下来,我们在任意一个地方输入///,即会自动出现注释模板,参数部分已经由占位符写好
2.如果你重启时误点了Skip Bundle(跳过包)解决办法
步骤如下:
从Xcode 5开始,苹果要求加入UUID证书从而保证插件的稳定性。因此Xcode版本更新之后需要在VVDocumenter-Xcode的Info.plist文件中添加Xcode的UUID。
一、查看Xcode的UUID
方法1
终端执行 defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID拷贝选中的字符串。
VVDocumenter-Xcode安装及遇到问题解决方案

方式2
在/Applications目录中找到Xcode.app,右键”显示包内容”,进入Contents文件夹,双击Info.plist打开,找到DVTPlugInCompatibilityUUID,拷贝后面的字符串。
VVDocumenter-Xcode安装及遇到问题解决方案
二、添加Xcode的UUID到VVDocumenter-Xcode的Info.plist文件
方式1--插件已经安装完成
1、打开xcode插件所在的目录:~/Library/Application Support/Developer/Shared/Xcode/Plug-ins;
找到在Dock栏中,右击Finder,点击前往文件夹VVDocumenter-Xcode安装及遇到问题解决方案

2、选择已经安装的插件例如VVDocumenter-Xcode,右键”显示包内容”;
3、找到info.plist 文件,找到DVTPlugInCompatibilityUUIDs的项目,添加一个Item,Value的值为之前Xcode的UUID,保存。
方式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”,不然插件无法使用
注:1. 查看VVDocumenter插件是否安装成功
在Xcode中查看Window下是否有VVDocumenter,有证明已经安装成功。
VVDocumenter-Xcode安装及遇到问题解决方案
是不是写注释变成了一件非常有趣的事,你还可以对其进行一些设置,在xcode->window菜单栏中,有VVDocumenter这个标签,里面可以对生成注释的模板进行一些设置,比如生成注释的快捷键,注释的对齐模式,注释显示创建者和时间等。例如如下设置就会生成这样的注释:
VVDocumenter-Xcode安装及遇到问题解决方案