《从零开始学Swift》学习笔记(Day 57)――Swift编码规范之注释规范:

前端之家收集整理的这篇文章主要介绍了《从零开始学Swift》学习笔记(Day 57)――Swift编码规范之注释规范:前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

《从零开始学Swift》学习笔记(Day 57)――Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释

原创文章,欢迎转载。转载请注明:关东升的博客

前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/)。这里来介绍一下他们的使用规范。

  1. 文件注释

文件注释就在每一个文件开头添加注释,文件注释通常包括如下信息:版权信息文件名、所在模块、作者信息、历史版本信息、文件内容和作用等。

下面看一个文件注释的示例:

/*
Copyright(C)2015EorientInc.AllRightsReserved.
SeeLICENSE.txtforthissample’slicensinginformation

Description:
ThisfilecontainsthefoundationalsubclassofNSOperation.

History:
15/7/22:CreatedbyTonyGuan.
15/8/20:Addsocketlibrary
15/8/22:Addmathlibrary
*/


这个注释只是提供了版权信息文件内容和历史版本信息等,文件注释要根据自己实际情况包括内容

  1. 文档注释

文档注释就是这种注释内容能够生成API帮助文档。文档注释主要对类型、属性方法函数功能

文档注释是稍微将单行注释(//)和多行注释(/*...*/)做一点“手脚”后,就成为了文档注释,单行文档注释(///)和多行文档注释(/**...*/)。

下面代码示例:

importFoundation

/**
Theprotocolthattypesmayimplementiftheywishtobe
notifiedofsignificantoperationlifecycleevents.
*/
protocolOperationObserver{

///Invokedimmediatelypriortothe`Operation`'s`execute()`method.
funcoperationDidStart(operation:Operation)

}


代码中使用了文档注释。

可以使用一些工具将这些文档注释生成API文件

  1. 代码注释

程序代码中处理文档注释还需要在一些关键的地方添加代码注释,文档注释一般是给一些看不到源代码的人看的帮助文档,而代码注释是给阅读源代码人参考的。代码注释一般是采用单行注释(//)和多行注释(/*...*/)。

有的时候也会在代码尾端进行注释,这要求注释内容极短,应该在有足够的空白来分开代码和注释。尾端注释示例代码如下:

init(timeout:NSTimeInterval){
self.timeout=timeout//初始化
}

  1. 使用地标注释

随着编码过程深入,工程代码量会增加,任何在这大量的代码中能快速找到需要方法或者是刚才修改代码呢?

Swift代码中使用地标注释,然后就可以使用Xcode工具在代码快速查找了。地标注释有三个:

  • MARK,用于方法函数的注释。

  • TODO,表示这里代码有没有完成,还要处理。

  • FIXME,表示这里修改代码

    这些注释会出现在XcodeJump Bar中。来看一个示例:

classViewController:UIViewController,UITableViewDataSource,UITableViewDelegate{

varlistTeams:[[String:String]]!

overridefuncviewDidLoad(){
super.viewDidLoad()
...
}

overridefuncdidReceiveMemoryWarning(){
super.didReceiveMemoryWarning()
//TODO:释放资源//使用TODO注释
}

//MARK:UITableViewDataSource协议方法//使用MARK注释
functableView(tableView:UITableView,numberOfRowsInSectionsection:Int)->Int{
returnself.listTeams.count
}

functableView(tableView:UITableView,cellForRowAtIndexPathindexPath:NSIndexPath)->UITableViewCell{

letcellIdentifier="CellIdentifier"

letcell:UITableViewCell!=tableView
.dequeueReusableCellWithIdentifier(cellIdentifier,forIndexPath:indexPath)as?UITableViewCell
//FIXME:修改bug//使用了FIXME注释
letrow=indexPath.row
letrowDict=self.listTeams[row]as[String:String]
...
returncell
}

//MARK:UITableViewDelegate协议方法//使用MARK注释
functableView(tableView:UITableView,didSelectRowAtIndexPathindexPath:NSIndexPath){
...
}
}


上述代码中使用三种地标注释,在使用时候后面要跟有一个冒号(:)

注释之后如果使用呢?打开XcodeJump Bar,如下图,这些地标注释会在下拉列表中粗体显示,点击列表项就会跳转到注释行。

wKiom1bdAULAHDyrAAGmhbs367M582.jpg



欢迎关注关东升新浪微博@tony_关东升。
关注智捷课堂微信公共平台,了解最新技术文章、图书、教程信息

wKiom1bc-5Cg7GPkAAAs2MBEZnc217.png


更多精品iOSCocos、移动设计课程请关注智捷课堂官方网站:http://www.zhijieketang.com
智捷课堂论坛网站:http://51work6.com/forum.php

猜你在找的Swift相关文章