大佬教程收集整理的这篇文章主要介绍了Swift注释风格,大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
良好的注释,有助于开发和维护,请正视注释!在Swift2.0
之前与之后是不一样的,这里是基于Swift2.0
的。
看看下面是笔者对UIActionSheet
封装的一个通用方法的注释:
/** * @author huangyibiao * * Block版本的actionSheet,具体如何使用请参考UIActionSheet * * @param inView 父视图 * @param title 标题 * @param canceltitle 取消按钮标题 * @param destructivetitle destructive按钮标题 * @param othertitles 其它按钮的标题 * @param callBACk 按钮点击的回调 * * @note 最多支持30项 * @see UIActionSheet * @see HDFActionSheetClickedButtonBlock * * @return 所呈现的UIActionSheet视图 */
+ (UIActionSheet *)hdf_showInView:(UIView *)inView
title:(NSString *)title
canceltitle:(NSString *)canceltitle
destructivetitle:(NSString *)destructivetitle
othertitles:(NSArray *)othertitles
callBACk:(HDFActionSheetClickedButtonBlock)callBACk;
上面只是一个API的注释例子,让我们分析:
在swift中就不推荐使用/**/的方式来注释API头了,因为我们发现输入/**/时,不会自动对齐了,这就显得难看了。更多地,我们会使用///
来注释。
/// Get the url of category of technology
///
/// - parameter currentPage: Current page index
/// - parameter pageSize: How many rows to load
///
/// - returns: The absolute url
static func technologyUrl(currentPage: Int,pageSize: int) ->String {
let url = "ArticleServer/queryArticleListByCategory/2"
return baseUrl + "\(url)/\(currentPagE)/\(pageSizE)"
}
由此简单的API注释可以看出来:
///
的方式来添加,苹果的API都使用了这种方式 parameter
参数名: 参数功能说明returns
: 返回说明当然,我们仍然可以使用/** */的方式,只是与苹果的方式保持一致,我相信会更好一些。事实上并不只是这些,在Swift中注释是@L_209_6@markdown语法的,因此只要您会Markdown语法,就可以添加超链接,图片,gif图片等。看看下面一张截图:
这是一张gif图,是可以看到动画的哦。
在参数中添加图片,只需要遵守Markdown语法即可轻松添加:![image](图片链接)
,这是固定的格式。
在参数中添加链接,只需要[显示的名称](超链接)
这是不是很强大呢?当组件化时,只需要将图片放在注释中,外部开发人员只需要按下option+鼠标点击就可以看到@L_489_33@了,比千言万语要容易懂。
注意:对于一个API头会采用上面的注释方式,但是在API内部,我们仍然会使用//或者/**/来注释某一行。对于代码块注释,我们也可以采用Markdown方式来注释,添加图片,链接等。
作为开发人员,怎么能不使用Xcode的插件呢,这有助于我们飞得更快。
在这之前,我们先安装一个插件管理器,在终端输入:
curl -fsSL https://raw.githubusercontent.com/supermarin/Alcatraz/deploy/Scripts/install.sh | sh
安装完成后,就可以搜索VVDocument
安装。
看下图,重启Xcode
后,在Xcode
的菜单栏window
中有一个Package Manager
,点击就可以打开Alcatraz
的界面,在搜索框中输入VVDocument
就可以搜索出来了,然后点击Install
即可,安装后需要重装启动Xcode
。如下图:
重启Xcode
后,在Window
中有一个叫VVDocument
的,点击它,就会显示如下界面,在这里就可以设置触发方式等,如下图:
上图为本人的设置界面,个人习惯以输入///
来触发自动生成注释。
微信公众号:iOSDevShares
有问必答QQ群:324400294
以上是大佬教程为你收集整理的Swift注释风格全部内容,希望文章能够帮你解决Swift注释风格所遇到的程序开发问题。
如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。