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

1. 文件注释

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

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

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

1. 文档注释

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

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

   下面代码示例：

   代码中使用了文档注释。

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

1. 代码注释

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

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

1. 使用地标注释

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

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

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

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

• FIXME，表示这里修改了代码。

  这些注释会出现在Xcode的 Jump Bar中。来看一个示例：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

class ViewController:UIViewController,        UITableViewDataSource, UITableViewDelegate {        var listTeams: [[String:String]]!        override func viewDidLoad() {         super.viewDidLoad()         ...     }        override func didReceiveMemoryWarning() {         super.didReceiveMemoryWarning()         //TODO: 释放资源                                 //使用TODO注释     }        // MARK: UITableViewDataSource 协议方法             //使用MARK注释     func tableView(tableView: UITableView,          numberOfRowsInSection section: Int) -> Int {         return self.listTeams.count     }        func tableView(tableView: UITableView,          cellForRowAtIndexPath indexPath: NSIndexPath) -> UITableViewCell {            let cellIdentifier ="CellIdentifier"            let cell: UITableViewCell! = tableView           .dequeueReusableCellWithIdentifier(cellIdentifier,                forIndexPath: indexPath) as? UITableViewCell         // FIXME: 修改bug                               //使用了FIXME注释         let row = indexPath.row         let rowDict = self.listTeams[row] as[String:String]         ...         return cell     }        // MARK: UITableViewDelegate 协议方法                   //使用MARK注释      鲜花 握手 雷人 路过 鸡蛋 该文章已有0人参与评论 请发表评论 评论 全部评论 专题导读 More+ 上一篇： 顶级 Swift 服务端框架对决 Node.js发布时间：2022-07-14 下一篇： Swift: 在Swift中桥接OC文件（自己创建的类文件、第三方库文件） ...发布时间：2022-07-14 热门推荐 More+ 热门话题 More+ 阅读排行榜 关于我们 创业团队 加入我们 媒体报道 合作伙伴 公益事业 产品与服务 寻求合作 项目投资 干货视频 经理人培训 招聘代理 解决方案 一站式 制造业 教育科研 行业案例 扫描微信二维码 查看手机版网站 随时了解更新最新资讯 139-2527-9053 在线客服（服务时间 9:00～18:00） 在线QQ客服 地址：深圳市南山区西丽大学城创智工业园 电邮：jeky_zhao#qq.com 移动电话：139-2527-9053 Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap 返回顶部