Swift：文档注释

1. 基本知识

import UIKit


class A {
    var x: Int
    
/**
     这是summary:这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出这是一个函数用来输出
     
     这是discussion:用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行用空行来换行
     
     - 天气不错
     - 哈哈哈
     
     1. 你好
     2. 我不好
     
     ```
     var x = 10
     print(\(x))
     ```
     
     **粗体**
     
     *斜体*
 */
    func printHello(){
        print("Hello!")
    }
    init(x: Int) {
        self.x = x
    }
}

2. 有关函数的注释

import UIKit


class A {
    var x: Int
    
/**
     - Parameters:
       - item1: 这是x
       - item2: 这是y
     
     - Returns:
       - 返回一个String值
     
     - Throws: printHello会抛出异常
 */
    func printHello(x: Int, y: Int) throws -> String {
        return "\(x + y)"
    }
    
    init(x: Int) {
        self.x = x
    }
}

3. MARK、TODO和FIXME

import UIKit


class A {
    var x: Int
    
    // MARK: - 方法
    func printHello(x: Int, y: Int) throws -> String {
        // TODO: 还要输出
        return "\(x + y)"
    }
    
    // FIXME: 这个要加required
    init(x: Int) {
        self.x = x
    }
}