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

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

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

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

安装与使用方法:下载github源码,使用xcode打开工程,运行一下,若是成功,插件就安装好了,这时,咱们必须将xcode从新启动一下,才能够使用。xcode

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

/**
 *  <#Description#>
 *
 *  @param data <#data description#>
 */
- (void)updateWithData:(id)data;

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

/**
 *  @author Elephant, 15-09-16 13:09:28
 *
 *  @brief  <#Description#>
 *
 *  @param data <#data description#>
 */
 - (void)updateWithData:(id)data;

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

专一技术,热爱生活,交流技术,也作朋友。code

——珲少 QQ群:203317592ip

相关文章
相关标签/搜索