swift doucment comments

Swift-flavored Markdown

1. 喜大普奔 可以用Markdown为swift写注释

Basic Markup

单行注释 （///） 多行注释 (/** ... */)
一些标准的Markdown语法也可以使用

• 段落用空行分隔。
• 无序列表由项目符号（ - ，+，*或•）标记。
• 有序列表使用数字（1,2,3，...），后跟一个句点 例如 1.
• 标题前面有＃符号或带下划线-

Summary & Description

文档注释的首段落成为文档摘要

如果文档注释以段落以外的任何内容开头，则其所有内容都将放入Discussion下

Parameters & Return Values

Parameter：以Parameter：开头 后面跟信息
Returns values：以Returns:开头 后面跟信息
Thrown errors：以Throws:开头 后面跟信息

Additional Fields

Swift风格的Markdown还定义了一些其他字段，详见引用

例子

/**
     concurrent queue will limit the thread count.
     
     Calling this method will syc dispatch a block in the current queue.
     this method maybe blcok the reveiver thread
     - Parameters:
        - work: The block to execute.
     - Precondition: the blcok paramater in `work` must be called.
     */
    public func sync(execute work: @escaping (LimitedLeave) -> Void) {
    }

image.png

引用

Swift Documentation