Xcode
代码标记
- MARK: 标记
1// MARK: - 这是一处代码标记
- TODO: 待完成的任务
1// TODO: - 待完成的任务
- FIXME: 修复的错误
1// FIXME: - 修复的 BUG 描述
代码注释
右键点击要添加的代码，会弹出一个操作菜单，点击 Add Documentation，即可在代码上方生成注释模版
1/// 代码注释的简短介绍。例如：TableViewCell 被点击时调用
2///
3/// 这里写一些详细的说明
4/// - Parameters:
5/// - tableView:
6/// - indexPath:
7
8func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
9 ...
10}
注释中的 Markdown 语法
1/// 这里是一段 Markdown 语法的注释
2///
3/// # 标题
4///
5/// ## 副标题
6///
7/// ### 三级标题
8///
9/// #### 四级标题
10///
11/// ##### 五级标题
12///
13/// 1. 列表
14/// 2. 列表
15///
16/// * 列表
17/// * 列表
18///
19/// ```swift
20/// //代码块
21/// ```
22///
23/// > 引用, 在 Xcode 中展示为笔记
24///
25/// **加粗**
26///
27/// *斜体*
28///
29/// ~~删除线~~