美文网首页
代码注释

代码注释

作者: 阶梯 | 来源:发表于2018-04-23 15:46 被阅读90次

注释形式
单行注释,多行注释,方法注释,方法集注释(配合代码块实现快速注释)

1. 单行注释

  • 使用 // 注释单行代码,最常见的使用场景是在方法内注释某个属性或某块区域的含义。

2. 多行注释

  • 使用 /** 文本 **/ 的注释格式(快捷键cmd+option+/)可以对属性和类以及方法进行注释,与//不同的是,该注释方式可以写多行,一般使用在类的头文件,多行介绍当前类的含义。
属性注释.png

3. 方法注释

  • 与方法2相同,使用 /** 文本 **/ 的注释格式(快捷键cmd+option+/)可以对方法进行注释,快捷键会根据方法参数自动生成需要填写的注释内容,并且在其他地方使用该方法时,Xcode会智能提示出之前写的注释内容,如下图:

在方法上方使用快捷键 cmd+option+/:


方法注释.png

使用该方法时显示注释内容:

调用方法显示注释.png

4:方法集注释 【方便快速查找】

#pragma mark --- 测试Action

  • 为了快速定位类中的某块代码,或某个方法,Xcode为我们提供了方法集的注释方式,可大大减少搜寻目标代码的时间,如图:
快速查找.png

相关文章

  • Python 代码注释格式

    Python代码 注释 # 注释内容 # 订单模块 HTML代码 注释

  • Android studio 上非常好用的快捷键

    注释代码(//) Ctrl + / 注释代码(/**/) Ctrl + Shift + / 格式化代码 ...

  • Android Studio Mac快捷键

    // Command + / 注释代码 注释代码(/**/) Command + Option + / 格式...

  • Xcode 插件的使用

    1.代码注释(单行注释,多行注释,方法注释,方法集注释)2.使用Xcode自定义代码块 第一个问题:代码注释插件 ...

  • Python之注释

    以#开头的行就是注释 单行注释:#注释 #只能注释掉#后的部分 代码前的注释是为了解释下面的代码;代码后的注释是为...

  • ECLIPSE快捷键和注释

    JAVA的注释有单行注释:// 一般用于单行代码注释 多行注释:/* * */ 一般用于多行代码注释 文档注释...

  • iOS 注释

    1、规范的注释让代码更好看 2、规范的注释让代码更实用 注释(单行注释) /* <##> */ 注释(预编译注释...

  • idea环境快捷键

    ActionMac OSXWin/Linux 注释代码(//)Cmd + /Ctrl + / 注释代码(/**/)...

  • Java基本语法

    注释:单行注释://[用一行注释对代码进行解释说明] 多行注释:/**/ [用多行注释对代码进行解释说明(注释一...

  • studio快捷键

    Ctrl + / : 代码注释(//) Ctrl + Shift +/ : 代码注释(/**/--需选中代码) C...

网友评论

      本文标题:代码注释

      本文链接:https://www.haomeiwen.com/subject/lurllftx.html