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

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

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

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

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

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

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

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

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

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

时间: 2024-10-06 16:35:34

iOS生成标准的注释工具——VVDocumenter的相关文章

iOS开发- Xcode插件(一)-规范注释生成器VVDocumenter

分享几个常用的Xcode插件. 第一个, 规范注释生成器VVDocumenter. 顾名思义, 它可以很方便的为你自动添加注释 使用效果如下: 下载链接:https://github.com/onevcat/VVDocumenter-Xcode 使用说明: 1.前往GitHub下载工程文件:VVDocumenter-Xcode 2.用Xcode打开工程,Command + B Build成功后,可以在~/Library/Application Support/Developer/Shared/X

Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具

Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目Sandcastle 本身是一个console的程序,为了方便使用,我们可以使用他的GUI版本:Sandcastle Help File Builder. 第一步,为你写的代码添加XML注释 我们创建一个简单的ClassLibrary1项目最为示范: using System; using System.Collections.Gen

20个可以帮你简化iOS app开发流程的工具

这里推荐20个可以帮你简化iOS app开发流程的工具.很多开发者都使用过这些工具,涉及原型和设计.编程.测试以及最后的营销,基本上涵盖了整个开发过程. 原型和设计 有了一个很好的创意后,你要做的不是立刻编程,而是设计UI和创建原型,这样你才能知道app如何运行,根据用户体验需要做哪些调整. App Cooker AppCooker 不仅是一个创建原型的优秀工具,它提供的许多功能还可以帮助你将程序发布到App store中.它集成了Dropbox,Box.net和photo roll,你可以直接

在线数据库表(sql语句)生成java实体类工具 - 参考手册

SQL建表语句 说明 格式良好的SQL建表语句,可以是直接从PowerDesigner.Navicat等工具中导出SQL建表语句.所谓格式良好,是指建表指令与表名必须在一行,字段名称.类型.注释必须在一行,因为这个工具是用正则实现的,并不是语法解析器,当然,以后有时间的话,会改进成解析器. 举例 -- ---------------------------- -- Table structure for t_activity -- ---------------------------- DRO

Xcode插件(一)-规范注释生成器VVDocumenter

原文来自:http://blog.csdn.net/hitwhylz/article/details/27813315 分享几个常用的Xcode插件. 第一个, 规范注释生成器VVDocumenter. 顾名思义, 它可以很方便的为你自动添加注释 使用效果如下: 下载链接:https://github.com/onevcat/VVDocumenter-Xcode 使用说明: 1.前往GitHub下载工程文件:VVDocumenter-Xcode 2.用Xcode打开工程,Command + B

?生成chm文档工具- Sandcastle -摘自网络

Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够 生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为 我们提供完美的.NET类库文

PHP标准的注释方法

PHP标准的注释方法: 单行注释语法: 用 // 开头,作为单行注释; 用 # 开头,作为单行注释; 多行注释语法: 以 /* 开头,以 */结束的多行注释:

在线数据库表(sql语句)生成java实体类工具

相信每个做java开发的读者,都接触过SQL建表语句,尤其是在项目开发初期,因为数据库是项目的基石. 在现代项目开发中,出现了许多ORM框架,通过简单的实体映射,即可实现与数据库的交互,然而我们最初设计的一定是数据库表结构,而不是实体类.实体类仅仅是对底层数据结构的有损压缩,它仅仅是数据载体,不具备数据归档能力. 因此,很多时候,我们需要将原始的SQL建表语句转换成java实体类,这项工作看似简单,但若人工完成,工作量也是相当可观的,而且难免会出现差错. 到目前为止,笔者还没有发现比较靠谱的此类

iOS开发-博客导出工具开发教程(附带源码)

前言: 作为一名学生, 作为一名iOS开发学习者, 我个人浏览信息包括博客, 更多的选择移动终端.然而, csdn并没有现成的客户端(不过有个web版的). 之前曾经看到一款开源的导出工具, 但是它是基于Windows平台的.导出的也仅仅是PDF格式.而且, 对于文章的导出, 需要精确URL.无法做到边浏览别导出. 另外, 我想实现的是, 可以在没有网络的情况下, 浏览自己收藏的文章.并且, 对于自己收藏的文章, 可以分类管理. 最关键的是, 对于自己的文章, 可以做一个备份.我曾经遇到过这样一