首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Swift3.0 - 注释

Swift3.0 - 注释

作者头像
酷走天涯
发布2018-09-14 14:46:42
5060
发布2018-09-14 14:46:42
举报
  • 第一种 单行注释
// 这是一个单行注释
  • 第二种 多行数组
/* 这是一个注释
多行注释 */
  • 第三种 有头和尾的多行注释
 /* 注释的开头
 /*注释的内容部分 */
 注释的结尾*/
  • 第四种 标记函数
// 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: 提示需要修改的地方

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

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2016.10.06 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档