• IOS注释几种方式

    2016-05-02 09:51:24
    ios注释几种方式

    最常见的三种注释方式:
    第一种:/* 内容 */
    第二种://内容
    第三种:#pragma mark 内容 //会在编辑器导航栏生成如下图(图1)有助于查找
    这里写图片描述
    其他编辑器系统默认方式(效果如图2):
    1.// !!!: 内容
    2.// ???: 内容
    3.// TODO:内容
    4.// FIXME:内容
    这里写图片描述
    设置自己的注释标示:
    进入项目-属性设置那个页面
    选择一个Target
    选择Build Phases标签
    点击右下角的Add Build Phase
    选择Run Script Psase,
    展看上面刚出现那一栏Run Script,输入以下内容(如图3)

    KEYWORDS="TODO:|FIXME:|\?\?\?:|\!\!\!:"
     find "${SRCROOT}" -name "*.h" -or -name "*.m" -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

    这里写图片描述

    展开全文
  • iOS—常用的注释方法

    2014-09-16 15:54:31
    1、两连续斜杆”//”后,该行内容将变成注释 【快捷键:选中行按下 command+/】 1 //注释内容 2、以”/*”开头,注释开始 “*/”结尾,终止注释 1 /*...

    1、两连续斜杆”//”后,该行内容将变成注释 【快捷键:选中行按下 command+/】

    1
    //注释内容

    2、以”/*”开头,注释开始 “*/”结尾,终止注释

    1
    /*注释内容*/

    3、方法注释一般写在方法名前面。以”/**”开头,以”*/”结尾

    1
    2
    /**方法注释一*/
    -(void)action;

    QQ20140522-1

    4、方法注释带详细的参数与描述

    1
    2
    3
    4
    5
    6
    /**
     *@brief 方法注释二
     *@param i 整型
     *@return 返回Bool
     */
    -(BOOL)btnAction:(int)i;

    QQ20140522-2

    5、mark标记,主要用于做段标记

    1
    2
    #pragma mark 标记1
    #pragma mark - 标记2

    QQ20140522-3

    6、warning警告,黄色的小警告

    1
    #warning - 看这里

    QQ20140522-4
    QQ20140522-5

    展开全文
  • iOS 注释方法

    2016-04-28 11:30:54
    iOS下有多中注释的方法 可以方便我们查看代码,通用的//和/**/这里就不多说了 OC #pragma mark - AFHTTPRequestOperation swift // TODO: add // FIXME: BUG // MARK: -

    在iOS下有多中注释的方法 可以方便我们查看代码,通用的//和/**/这里就不多说了

    OC

    #pragma mark - AFHTTPRequestOperation


    swift

    // TODO: add


    // FIXME: BUG


    // MARK: - 



    也可以 把//TODO: 和//FIXME: 加上警告 如下面操作 不过个人没这个习惯


    TAGS="TODO:|FIXME:"
    echo "searching ${SRCROOT} for ${TAGS}"
    find "${SRCROOT}" \( -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"



    展开全文
  • iOS 注释大全

    2018-10-16 09:12:46
    1.单行注释 1.1 简单注释 常用于 ==> 说明代码块中某段或某句的含义 用法 ==> 单独一行或者在某行代码的尾部 command + / 键 快捷注释某段代码 //注释文字 1.2 pragma mark 常用于 ==> ...

    1.单行注释

    1.1 简单注释

    常用于 ==> 说明代码块中某段或某句的含义
    用法 ==> 单独一行或者在某行代码的尾部
    command + / 键 快捷注释某段代码

    //注释文字
    
    1.2 pragma mark

    常用于 ==> 添加在代码行中便于从Xcode顶部地址栏中查找

    #pragma mark 注释文字
    

    2.多行注释

    添加此注释后就会在写此方法的智能提示中显示此方法说明

    2.1 简单注释

    常用于 ==> 说明某个属性或者说明某个类的详情,也可注释某段代码
    用法 ==>> 可书写多行
    command + option + / 键 快捷注释某段代码

    /**
      注释文字
      */
    
    2.2 方法注释

    常用于 ==> 说明某个方法
    用法 ==>> 可分行书写多个参数信息
    command + option + / 键 Xcode可智能列出注释参数

    /**
    此处可添加方法注释文字
    @param first  注释此参数first
    @param second 注释此参数second
    @return 注释此方法返回参数
    */
    - (NSString *)getResultWithParamFirst:(NSString *)first withParamSecond:(NSString *)second{
    
    }
    

    ###附录:注释标记大全
    添加下面参数 在Xcode中 option键+点击函数会调出详细注释,方便阅读代码

    /** 
    * @brief 简要描述 
    * @author 标明开发该类模块的作者 
    * @discussion 用途,方法
    * @abstract   简介,概念
    * @header  文件名
    * @version 标明该类模块的版本 
    * @see 参考转向,相关主题 
    * @param 相关参数的说明 
    * @return 对方法返回值的说明 
    * @exception 对方法可能跑出的异常进行说明 
    * @throw 抛出的异常 
    * @since 从哪个版本此方法可以使用 
    * @deprecated 弃用此API,从哪个版本开始 
    * @serial (or @serialField or @serialData) 
    * @link 链接相关方法 
    * @copyright  版权
    * /
    参考网上帖子整理
    
    展开全文
  • 这时候可能就需要文档或者注释来帮助之后的开发者(包括大家自己)尽快熟悉和方便修改。 我在开发和学习的过程中看到有人使用///就能在一个方法前面快速生成规范的Javadoc格式文档注释,所以上网查了查才知道原来是...

    虽然ObjC代码因为其可读性极强,而不太需要时常查阅文档,但是其实对于大多数人(包括我自己)来说,可能为方法或变量取一个好名字并不是那么简单的事情。这时候可能就需要文档或者注释来帮助之后的开发者(包括大家自己)尽快熟悉和方便修改。

    我在开发和学习的过程中看到有人使用///就能在一个方法前面快速生成规范的Javadoc格式文档注释,所以上网查了查才知道原来是使用了插件的原因,仔细查询了下VVDocumenter Xcode这个插件效果还是很不错的,可以用///来快速生成文档注释(我之前看到的人用的是什么我就不得而知了),作者在GitHub上上传了该插件,

    GitHub链接:  https://github.com/onevcat/VVDocumenter-Xcode

    另外也可以在csdn下载

    csdn下载地址:http://download.csdn.net/detail/winzlee/8626171


    至于这插件如何用,当然也是很简单的,只需要解压之后直接点击,用Xcode 打开,直接run,run成功之后再重启Xcode 即可,最后打开自己的项目就可以在方法前输入///来快速生成方法注释了。我的是xcode6.2,可以运行。


    这原理就是xcode有一个自己的插件库,当在xcode中run这个插件的时候xcode就会检测到这个插件,并把这个插件加入到自己的插件库中,重启xcode后就能在别的程序中运行此插件了。


    效果图:



    这原理就是xcode有一个自己的插件库,当在xcode中run这个插件的时候xcode就会检测到这个插件,并把这个插件加入到自己的插件库中,重启xcode后就能在别的程序中运行此插件了。
    展开全文
  • 注释规范  良好的编码规范是程序员必备的素质,编码中的代码注释尤为重要,健全的代码注释可以提高代码可读性和维护性,不仅为了标识此块代码的含义,很多时候包含了对业务逻辑的解释,项目中难免有逻辑复杂...
  • 注释规范  良好的编码规范是程序员必备的素质,编码中的代码注释尤为重要,健全的代码注释可以提高代码可读性和维护性,不仅为了标识此块代码的含义,很多时候包含了对业务逻辑的解释,项目中难免有逻辑复杂之处,...
  • iOS 代码注释规范

    2017-02-08 12:00:23
    一、注释写法1.1 注释形式1.1.1 单行注释在很多时候只需写一个简要描述就够了,这时最好使用单行注释。推荐格式为// 简要描述.1.1.2 多行注释当需要写详细描述时,这时就需要使用多行注释了。推荐格式为/** 简要描述...
  • iOS常用的注释方法

    2014-08-16 03:43:37
    iOS常用的注释方法 1、两连续斜杆”//”后,该行内容将变成注释 【快捷键:选中行按下 command+/】 //注释内容 2、以”/*”开头,注释开始 “*/”结尾,终止注释 /*注释内容*/ 3、方法注释一般写在...
  • 常见的注释iOS举例来说,一般有三种:  单行注释 //  多行注释 /* */  文档注释 /** */ 我们要做的就是应用替换功能把注释都替换为空,这样就解决了删除注释的目的。  点击快捷键 "⌘+3" or ...
  • 转载自: ... ... ...代码的注释经常被人忽略,以至于在后期维护的时候较为困难。我们准备在XX项目开始之前制定一套规范的注释体系,致力于达到就算维护人员改变也能快速上手的效果。 1
  • IOS代码注释小结

    2015-06-05 16:50:18
    代码注释的必要性:想想看,半年之前代码,如果没有注释,是什么结果,擦,谁写的,写的啥?。。。好像是我写的。。 减少同事之间的沟通成本 快速恢复代码记忆 快速生成文档 注释的形式形式A: /// Single ...
  • ios开发 之 注释规范

    2017-04-12 11:42:38
    1、代码的注释经常被人忽略,其实注解有很多好处: (1)方便使用,会提示注解说明 (2)方便日后自己阅读代码 (3)方便别人阅读自己代码 (4)降低后期维护成本 (5)可以快速生成开发文档 2、代码的...
  • 开发过程中难免需要很多的注释,方便自己开发,也方便他人阅读代码1.常用的 //,以及/**/就不多提了 单行注释以及块注释2./**注释*/ 在方法或者属性声明前加上这种注释,会在调用方法或者设置属性时提示你所写的注释,...
  • iOS/Xcode 自动生成注释

    2015-03-18 12:42:19
    Xcode代码注释工具vvDocumenter 下载插件地址:https://github.com/onevcat/VVDocumenter-Xcode 安装:运行下载的vvDocumenter工程,重启Xcode 使用:方法前面///,自动完成框架,修改对应说明
  • iOS xcode 9 注释快捷键

    2017-10-02 01:07:44
    单行注释:在方法的地方按 Command+/标注的功能,快捷键是Command + Option + / 需要在方法名的上面(空白)的地方按 Command + Option + / 才管用
  • 这是一门快速入门iOS开发的课程,目的是让大家快速学会,iOS开发环境搭建,和iOS一些基础知识,最后完成一个小项目。 项目信息 提供完整的Git提交历史,和每节视频一一对应,目前有41次...
  • 这个是因为苹果解决xcode ghost,把插件屏蔽了。解决方法打开终端,命令运行: sudo /usr/libexec/xpccachectl然后必须重启电脑后生效
  • iOS过滤json注释字段

    2018-12-13 16:22:20
    iOS过滤json注释字段 我们的后台习惯在接口文档的json示例中直接添加注释,有时候测试环境不满足条件无法测试某部分数据,使用接口文档中的json直接转换成模拟数据就相当方便,但是注释和一些不符合的数据要手动...
  • 第一步:下载插件 ...第二步:有关介绍和安装: http://www.th7.cn/Program/IOS/201506/484499.shtml另外,其他好用的第三放插件: http://www.cocoachina.com/industry/20130918/7022.html
1 2 3 4 5 ... 20
收藏数 47,598
精华内容 19,039