Swift:文件註釋
阿新 • • 發佈:2018-12-12
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
}
}