[Swift]Xcode标记：MARK、TODO、FIXME

1. MARK

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

// MARK: - 说明文字,带分割线
// MARK: 说明文字,不带分割线

其他标记类似：‘-’为分割线，注意‘-’右侧为空字符。

代码示例：

 1 import UIKit
 2  
 3 class ViewController: UIViewController {
 4  
 5     override func viewDidLoad() {
 6         super.viewDidLoad()
 7     }
 8      
 9     // MARK: 业务处理相关方法（上方不带分割线）
10     func test1() {
11     }
12      
13     // MARK: - 数据请求相关方法（上方会带个分割线）
14     func test2() {
15     }
16 }

2. TODO

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

TODO: 需要提醒的文字

 代码示例：

 1 import UIKit
 2  
 3 class ViewController: UIViewController {
 4  
 5     override func viewDidLoad() {
 6         super.viewDidLoad()
 7     }
 8 
 9     func test() {
10         // TODO: 需要记录操作日志
11     }
12 }

3. FIXME

有时候在编程的过程中,会有一些小的bug,不紧急也不影响程序的运行,可以暂时不予处理,稍后需要修改,其用法类似TODO,只是语义有所区别。

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

FIXME: 需要修改bug的相关说明

 代码示例：

 1 import UIKit
 2  
 3 class ViewController: UIViewController {
 4  
 5     override func viewDidLoad() {
 6         super.viewDidLoad()
 7     }
 8  
 9     func test() {
10         // FIXME: 参数不正确时会导致崩溃
11     }
12 }