Xcode的Swift添加注释方法，添加注释、标记弃用、标记改名、编写代码文档

// 单行注释

/// 单行文档注释

/*
  第一行注释
  第二行注释
  第三行注释
*/

/**
  多行文档注释
*/

// MARK: 这个是标示
// MARK: - 这个是带分割线的标示

// TODO: 这个下边要写一些代码，实现某个目的。
// TODO: - 多了一条分割线。

// FIXME: 这个地方要修理一下。

/// 两个整数相加
/// - Parameters:
///   - a: 加号左边的整数
///   - b: 加号右边的整数
/// - Throws: 抛出错误，此方法不抛出错误，只为另外演示注释用法。
/// - Returns: 和
///
/// 这个是一个两个整数的相加方法，用于求两个整数的和。
func add(a: Int, b: Int) throws -> Int {
    return a + b
}

/**
    两个整数相加
    # 加法（标题一）
    这个方法执行整数的加法运算。
    ## 加法运算（标题二）
    想加个试试看
 
    中间隔着一个横线
    ***
 
代码块的*使用*方法:
``(不用添加括号)`

        let num = func add(a: 1, b: 2)
        // print 3
    ``(不用添加括号)`
        
    - c: 参数一
    - d: 参数二
    - f: 参数三
 
    - Parameters:
        - a: 加号左边的整数
        - b: 加号右边的整数
    - Throws: 抛出错误，此方法不抛出错误，只为另外演示注释用法。
    - Returns: 和
 
    - Important: 注意这个方法的参数。
    - Version: 1.0.0
    - Authors: Wei You, Fang Wang
    - Copyright: 版权所有
    - Date: 2020-12-28
    - Since: 1949-10-01
    - Attention: 加法的运算
    - Note: 提示一下，用的时候请注意类型。
    - Remark: 从新标记一下这个方法。
    - Warning: 警告，这是一个没有内容的警告。
    - Bug: 标记下bug问题。
    - TODO: 要点改进的代码
    - Experiment: 试验点新玩法。
    - Precondition: 使用方法的前置条件
    - Postcondition：使用方法的后置条件
    - Requires: 要求一些东西，才能用这个方法。
    - Invariant: 不变的
 */
func add(a: Int, b: Int) throws -> Int {
    return a + b
}

@available(*, unavailable, renamed: "def")
var abc = "hello"

var def = "hello"

@available(*, deprecated, renamed: "loadData")
func fetchData() { }

@available(*, deprecated, message: "Parse your data by hand instead")
func parseData() { }

@available(swift, obsoleted: 4.1, renamed: "attemptConnection")
func testConnection() { }

@available(swift, deprecated: 4.0, obsoleted: 5.0, message: "This will be removed in v5.0; please migrate to a different API.")

@available(swift, introduced: 4.2)
func loadUsers() { }