首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Swift3.0 - 注释

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

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

好处:

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

让学习成为一种习惯

  • 第八种 和上面差不多
代码语言:javascript
复制
  /** 
    定义一个查询学生成绩的接口
 
       let score =  getScoreStudentName(name: "酷走天涯", nums: "111111111")

     - Parameters:
         - name:  学生姓名
         - nums:  学号
     - Returns: 返回学生成绩
     */
  • 第九种 个人最喜欢的
代码语言:javascript
复制
//  MARK: 定义一个查询学生成绩的接口
/// 定义一个查询学生成绩的接口
///
///     let score =  getScoreStudentName(name: "酷走天涯", nums: "111111111")
///
/// - Parameters:
///     - name:  学生姓名
///     - nums:  学号
/// - Returns: 返回学生成绩

让学习成为一种习惯

让学习成为一种习惯

  • 其他
代码语言:javascript
复制
// MARK: 粗体标签
// WARNING:  警告提示
// TODO: 提示未完成的地方
// FIXME: 提示需要修改的地方

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

举报
领券