
原文链接:Swift 添加方法描述(文档注释)
感觉原作者总结的特别好,转发纪录之。
在Swift里为一个方法添加文档描述很简单,只需要用///就可以了,如:
/// Called when right button is clicked.
funcimagePickerControllerDIDSelectedAssets(images: [DKAsset]!)
看起来就是这样:
如果要描述方法参数,就作一个注释的空行,然后这样写:
/// Called when right button is clicked.
///
/// :param: images Images of selected
DKAsset]!)
看起来就是这样:
一个带return的完整方法描述就这样写:
/// :param: images Images of selected
/// :returns: voID
效果:
个人觉得比以前简洁方便了不少。
总结以上是内存溢出为你收集整理的Swift - Swift添加方法描述全部内容,希望文章能够帮你解决Swift - Swift添加方法描述所遇到的程序开发问题。
如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。
欢迎分享,转载请注明来源:内存溢出
微信扫一扫
支付宝扫一扫
评论列表(0条)