swift的文档注释一览

多行注释文档

/**
    多行注释文档相比于普通多行注释多了一个星号。
    在这里可以使用markDown语法，书写各种提示信息
    如：显示一个有序列表
    1. 有序列表
    2. 有序列表
    3. 有序列表
*/

image.png

方法/函数的注释

    ///- Parameters:
    ///     - value1: 第一个传入参数
    ///     - value2: 第二个传入参数

    ///- Returns: 返回值的说明
    ///- Throws : 出现异常的说明
    func doSomeThing(value1:String, vaule2:String, value3:String)->String{
        return "testStr"
    }

源信息注释

    ///- Authors: 开发人员 xxx
    ///- CopyRight: 版权信息
    ///- Date: 15 July 当前开发时间
    ///- Since: iOS 13.0
    ///- Version: 1.0.0

image.png

算法注释关键字

    /// - Precondition: 前置条件
    /// - Postcondition: 后置条件
    /// - Requires:  算法需要的信息
    /// - Invariant:  循环不变量
    /// - Complexity: 复杂度
    /// - Important: 描述重要信息
    /// - Warning:  描述警告信息
    /// - Attention: 描述注意事项
    /// - Note:  一些记录
    /// - Remark:  一些评论心得

image.png

标签注释关键字

    // MARK: - 在代码的某处添加一个标签，可以使查看类视图更加方便
    // TODO: - 将来可能会继续编辑的部分
    // FIXME: - 将要修改的部分

image.png

markdown注释

还可以插入图片

/**
 
 这里就是我们的文档内容,这里是第一段的文字
 
 如果有多段描述,需要分段,需要在段落之间添加一个空行
 
 如果有分类,无序列表可使用-或+或*后跟一个空格来书写,如下:
 - 第一项
 - 第二项
 + 第三项
 * 第四项
 
 有序列表可直接按如下方式书写:
 1. 第一项
 2. 第二项
 3. 第三项
 
 插入代码段:
  `` `
 let a = 1
 let name = "注释"
 print("\(name)"
`` `
 */
func SomeFunc(name: String) -> String {
   
    return "文档注释"
}

image.png