Swift中的地标注释

• 文件注释

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

1. 单行文件注释

//注释内容：文件的相关信息

2. 多行文件注释

/*
版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容和作用等。
*/

• 文档注释

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

1. 单行文档注释

/// 这里写注释内容 

2. 多行文档注释

    /// 设置TableView的Cell个数
    /// - Parameters:
    ///   - tableView: tableView description
    ///   - section: section description
    /// - Returns: UITableView
    func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return self.recommendArray?.count ?? 0
    }

• 地标注释

随着编码过程深入，工程代码量会增加，地标注释有助于在大量的代码中能快速找到需要方法或者是刚才修改过代码

1. MARK:

用于方法或函数的注释

// MARK: UITableViewDelegate And UITableViewDataSource

MARK

2. TODO:

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

// TODO:创建subView，需要在这里创建所有子视图

TODO

3. FIXME:

表示这里修改了代码

override init(frame: CGRect) {
     super.init(frame: frame)
     // FIXME:在这里自定义初始化数据
}

FIXME