黑马程序员技术交流社区

标题: 【精品分享】XCode中的方法块注释插件，等加分 [打印本页]

作者: mony 时间: 2015-5-17 23:38
标题: 【精品分享】XCode中的方法块注释插件，等加分
本帖最后由 mony 于 2015-5-18 16:29 编辑

看到很多人在论坛里问有木有可以快捷生成方法的注释插件。
类似于下面的样子：

/**
* 完成委托
*
* @param entrustId 委托ID
* @param driverId 司机ID
* @param reachFlag 到达标识
*/
-(void)setEntrustCompleteByEntrustID:(NSString *)entrustId DriverID:(NSString *)driverId ReachFlag:(NSString *)reachFlag{
}

复制代码

就是不愿意去打一遍注释，可是又需要这样的注释，肿么办呢？Look here！
这里有一个开源插件，这可是github上fork790+，4000+Star的项目，可想而知有多少人在用!
下面我就分享一下，并且说一下肿么安装。
首先，下载这个开源项目的工程。可以点击→ GitHub链接下载：https://github.com/onevcat/VVDocumenter-Xcode ，也可以下载楼主最后提供的百度云的连接（毕竟GFW有的时候太坑）。
打开，就像下图这样↓

然后呢，打开项目文件，如下图↓

然后直接编译并运行，等待执行成功，即可。说明插件文件已经写到XCode的目录下了。
想知道在哪，可以打开Finder，然后前往文件夹：~/Library/Application Support/Developer/Shared/Xcode/Plug-ins
就可以看到编译后的文件了。

接下来，完全关闭XCode，再打开你自己的项目，试着在一个方法上面输入///，看看会有什么神奇的效果发生。
下面借用作者的图片，看一下动态效果。

肿么样，是不是很炫？如果你还想配置这个插件的话，在XCode菜单栏 -> Window -> VVDocumenter 进行配置。
至于附件，我就隐藏一下，为了更多人可以看到这篇帖子，希望不要做一个伸手党。

有分的捧个分场，没分的捧个黑马币场，再没有的捧个人场也行{:3_51:}

作者: mony 时间: 2015-5-18 15:56
我去，难道没人觉得有用吗？

作者: jx836202365 时间: 2015-6-4 20:23
我过来学习的

作者: 李永方 时间: 2015-6-5 16:07
视频里面有讲解这个插件，好不好？

作者: aofex 时间: 2015-6-5 16:23
学习一下

作者: evenzhu1989 时间: 2015-6-5 21:25

作者: 七尺阳光 时间: 2015-6-5 21:48
为什么我的文件夹里有那个文件,而windows上没有VVDocumenter这个?

作者: 洋柿子 时间: 2015-6-5 22:07
偷偷下个安装。。绝对有用啊

作者: 鬼崇祟 时间: 2015-6-5 22:46
捧人场来了吼吼多谢分享

作者: talent123 时间: 2015-6-5 23:16
好东西学习下

作者: 晗修 时间: 2015-6-6 00:23
教程里明明有啊

作者: 张晓珊 时间: 2015-6-6 10:39
我觉得对于初学者还是手写注释比较好，一来锻炼了自己，二来代码注释本来就是为了让别人能更加清楚明白的看懂自己写的代码，但是使用程序生成的固定的注释肯定在灵活性与清晰可读性上有缺陷。如果说你写这些注释是因为公司或者老师要求必须写上注释才不得不写的，那么用插件就可以。但是如果真是为了保证自己代码的可读性，建议还是手写代码，这样才能更简单，准确，清晰，明了的传达自己的编程思想！

作者: jife94 时间: 2015-6-6 12:06
:L 这都要隐藏啊……

作者: Dariel 时间: 2015-6-6 19:19
嗯，这个不错

作者: sunda1314520 时间: 2015-6-6 20:38
视频里面有讲解这个插件，好不好？

作者: 为梦想而生 时间: 2015-6-6 21:12
赞

欢迎光临黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2