Swift - Xcode常用标记介绍（MARK、TODO、FIXME）

作者：hangge | 2019-01-09 08:10

当一个代码文件中有很多方法时，要翻阅或者查找特定代码会十分不便。其实我们可以在代码中插入一些特殊格式的标记注释，从而帮助我们快速定位。这些注释不会在应用程序中添加任何功能，而只会在代码中创建逻辑分节。

当标记添加后，我们单击编辑器上方路径的最后一部分，这些标记将会与方法一起显示出来，从而能够快速定位到相应的代码。

1，MARK 标记

（1）MARK 又叫做代码标注，我们可以使用它来添加一些说明文字。同时可以选择其上方是否需要显示分割线。

import UIKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
    }
    
    // MARK: 业务处理相关方法（上方不带分割线）
    func test1() {
    }
    
    func test2() {
    }
    
    // MARK: - 数据请求相关方法（上方会带个分割线）
    func test3() {
    }

    func test4() {
    }
}

（2）效果如下：

2，TODO 标记

（1）当我们写代码时，如果有一些功能需要以后添加或者补全，那么就可以使用 TODO 关键字来标记提醒。

import UIKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
    }
    
    // MARK: - 数据请求相关方法（上方会带个分割线）
    func test3() {
    }

    func test4() {
        // TODO: 需要记录操作日志
    }
}

（2）效果如下：

3，FIXME 标记

（1）通常我们在 bug 的位置使用 FIXME 做标记，提醒我们稍后需要进行修改。

import UIKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
    }
    
    // MARK: - 数据请求相关方法（上方会带个分割线）
    func test3() {
    }

    func test4() {
        // FIXME: 参数不正确时会导致崩溃
    }
}

（2）效果如下：

Swift - Xcode常用标记介绍（MARK、TODO、FIXME）

1，MARK 标记

2，TODO 标记

3，FIXME 标记

全部评论（0）