Swift3.0 - 注释

Swift3.0 - 真的很简单
Swift3.0 - 数据类型
Swift3.0 - Array
Swift3.0 - 字典
Swift3.0 - 可选值
Swift3.0 - 集合
Swift3.0 - 流控制
Swift3.0 - 对象和类
Swift3.0 - 属性
Swift3.0 - 函数和闭包
Swift3.0 - 初始化和释放
Swift3.0 - 协议protocol
Swift3.0 - 类和结构体的区别
Swift3.0 - 枚举
Swift3.0 - 扩展
Swift3.0 - 下标
Swift3.0 - 泛型
Swift3.0 - 异常错误
Swift3.0 - 断言
Swift3.0 - 自动引用计数(strong,weak,unowned)
Swift3.0 - 检测API
Swift3.0 - 对象的标识
Swift3.0 - 注释
Swift3.0 - 元类型
Swift3.0 - 空间命名
Swift3.0 - 对象判等
Swift3.0 - 探究Self的用途
Swift3.0 - 类簇
Swift3.0 - 动态调用对象(实例)方法
Swift3.0 - 文本输出
Swift3.0 - 黑魔法swizzle
Swift3.0 - 镜像
Swift3.0 - 遇到的坑

  • 第一种 单行注释
// 这是一个单行注释
  • 第二种 多行数组
/* 这是一个注释
多行注释 */
  • 第三种 有头和尾的多行注释
 /* 注释的开头
 /*注释的内容部分 */
 注释的结尾*/
  • 第四种 标记函数
// MARK: - 标记在函数前面
  • 第五种 Java 风格注释
/*
 * @func  定义一个查询学生成绩的接口
 * @param name 学生姓名
 * @param nums 序号
 * @return 返回查询到的成绩
 */
  • 第六种 苹果官方使用/// 注释属性
/// The number of seconds from 1 January 1970 to the reference date, 1 January 2001.
public static let timeIntervalBetween1970AndReferenceDate: TimeInterval
  • 第七种 苹果官方注释方法
/// 定义一个查询学生成绩的接口
///
///     let score =  getScoreStudentName(name: "酷走天涯", nums: "111111111")
///
/// - Parameters:
///     - name:  学生姓名
///     - nums:  学号
/// - Returns: 返回学生成绩

func getScoreStudentName(name:String,nums:String)->Double{
    return 0.0
}

好处:

按住option + 鼠标左键查看方法说明

让学习成为一种习惯
  • 第八种 和上面差不多
  /** 
    定义一个查询学生成绩的接口
 
       let score =  getScoreStudentName(name: "酷走天涯", nums: "111111111")

     - Parameters:
         - name:  学生姓名
         - nums:  学号
     - Returns: 返回学生成绩
     */
  • 第九种 个人最喜欢的
//  MARK: 定义一个查询学生成绩的接口
/// 定义一个查询学生成绩的接口
///
///     let score =  getScoreStudentName(name: "酷走天涯", nums: "111111111")
///
/// - Parameters:
///     - name:  学生姓名
///     - nums:  学号
/// - Returns: 返回学生成绩
让学习成为一种习惯
让学习成为一种习惯
  • 其他
// MARK: 粗体标签
// WARNING:  警告提示
// TODO: 提示未完成的地方
// FIXME: 提示需要修改的地方

您觉得那种注释风格比较好,请求留言讨论

推荐阅读更多精彩内容