前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >iOS生成标准的注释工具——VVDocumenter

iOS生成标准的注释工具——VVDocumenter

作者头像
珲少
发布2018-08-16 11:21:04
9960
发布2018-08-16 11:21:04
举报
文章被收录于专栏:一“技”之长

iOS生成标准的注释工具——VVDocumenter

        在程序开发中,我们免不了要写许多注释,方便帮别人也方便我们自己以后检查我们的代码。然而,写注释是一件十分浪费我们时间与精力的事,要写符合文档格式的注释,更是会消耗我们很多的功夫,幸运的是,VVDocumenter可以帮我们很大的忙。

        gitHub地址:https://github.com/onevcat/VVDocumenter-Xcode

安装与使用方法:下载github源码,使用xcode打开工程,运行一下,如果成功,插件就安装好了,这时,我们必须将xcode重新启动一下,才可以使用。

重启xcode,在任意一个地方输入///,即会自动出现如下的注释模板,参数部分已经由占位符写好

代码语言:javascript
复制
/**
 *  <#Description#>
 *
 *  @param data <#data description#>
 */
- (void)updateWithData:(id)data;

是不是写注释变成了一件非常有趣的事,你还可以对其进行一些设置,在xcode->window菜单栏中,有VVDocumenter这个标签,里面可以对生成注释的模板进行一些设置,比如生成注释的快捷键,注释的对齐模式,注释显示创建者和时间等。例如如下设置就会生成这样的注释:

代码语言:javascript
复制
/**
 *  @author Elephant, 15-09-16 13:09:28
 *
 *  @brief  <#Description#>
 *
 *  @param data <#data description#>
 */
 - (void)updateWithData:(id)data;

最后,推荐这款小插件给你,祝你写代码愉快O(∩_∩)O。

专注技术,热爱生活,交流技术,也做朋友。 ——珲少 QQ群:203317592

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2015/09/16 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • iOS生成标准的注释工具——VVDocumenter
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档