Swift 添加方法描述(文档注释)

简介: 在Swift里为一个方法添加文档描述很简单,只需要用///就可以了,如:/// Called when right button is clicked.

在Swift里为一个方法添加文档描述很简单,只需要用///就可以了,如:

/// Called when right button is clicked.

func imagePickerControllerDidSelectedAssets(images: [DKAsset]!)

看起来就是这样:


如果要描述方法参数,就作一个注释的空行,然后这样写:

/// Called when right button is clicked.

///

/// :param: images Images of selected

func imagePickerControllerDidSelectedAssets(images: [DKAsset]!) 

看起来就是这样:


一个带return的完整方法描述就这样写: 

/// Called when right button is clicked.

///

/// :param: images Images of selected

/// :returns: void

func imagePickerControllerDidSelectedAssets(images: [DKAsset]!) 

效果:



个人觉得比以前简洁方便了不少。

目录
相关文章
|
6天前
|
Swift iOS开发
Swift 方法
10月更文挑战第29天
13 4
|
6月前
Swift4.0判断本函数是否在其它类有相同的方法
Swift4.0判断本函数是否在其它类有相同的方法
43 0
|
Swift 开发者
Swift - swift3.0中代理方法的使用
Swift - swift3.0中代理方法的使用
85 0
|
Swift 索引
Swift - 字典排序方法
Swift - 字典排序方法
178 0
|
Swift
OC 和 swift 创建单例方法
OC 和 swift 创建单例方法
326 0
|
前端开发 Swift
Swift实用小册10:实例方法和类型方法的使用
Swift实用小册10:实例方法和类型方法的使用
221 0
Swift实用小册10:实例方法和类型方法的使用
|
存储 编译器 Swift
Swift5.0 - day4-闭包、属性、方法、下标
Swift5.0 - day4-闭包、属性、方法、下标
323 0
Swift5.0 - day4-闭包、属性、方法、下标
|
Swift 编译器
Swift - 实例对象调用协议方法优先级分析/ witness_methos witness_table分析
本文主要探究: 当一个类遵循了协议,且协议和类都有方法实现时,实例对象调用方法的优先顺序
Swift - 实例对象调用协议方法优先级分析/ witness_methos witness_table分析
|
存储 Swift iOS开发
Swift5.1—类型方法
Swift5.1—类型方法
124 0
|
Swift 开发者 iOS开发
Swift讲解专题十二——方法
Swift讲解专题十二——方法
193 0