Swift 注释格式使用技巧小结
2015-08-26 13:34
513 查看
在之前的Xcode版本中使用注释插件 VVDocumenter
可以快速的根据上下文的环境生成相应的注释格式,但是该插件目前在 Xcode7 bate 版中并不太兼容,这就需要我们了解一下原生的注释格式怎么书写了,现总结以下自己使用的几种格式与大家共同交流。
Swift 中的普通注释与 Objective-C 中的一致,大概分为以下三种
// 单行注释/ * 多行注释 */
/// 标记注释1
/** 标记注释2 */
针对于 Swift 中函数的原生注释方法在此列举几个如下,使用好了可以让别人更容易读懂我们的代码功能以及具体的参数意义。
示例1:
示例2:
示例3:
示例4:
Objective-C 的三种常用注释介绍:
示例1:
示例2:
示例3:
示例4:
最后再补充两个标记注释,可以便利的标记某一块函数列表的功能,已便后续查找维护对应的函数
相关文章推荐
- 《从零开始学Swift》学习笔记(Day 6)——哎呀常量和变量都该什么时候用啊?
- swift 选取图库中的图片
- Swift 2.0学习笔记(Day 6)——哎呀常量和变量都该什么时候用啊?
- Swiftly语言学习1
- Swift 运算属性
- Swift 学习记录—1
- 使用@noescape解决Swift闭包“保留环”问题
- Swift 属性值监测
- Swift学习笔记系列——(17)错误处理
- Swift学习笔记之公用库和模块化
- 使用@autoclosure提高Swift代码质量
- swift 类型定义
- Swift编程规范:保持代码优美的10个方法
- swift - The Facade Pattern
- swift详解之十一------------协议、委托(代理)模式
- Swift编程语言学习2.1——基础运营商(在)
- 《从零开始学Swift》学习笔记(Day5)——我所知道的标识符和关键字
- Swift 结构体
- ios开发学习----swift学习之(一)字符串
- Swift - 将定位获取的经纬度转换为城市名