swift的常用注释语法

/// 这是一个结构体。 ///
/// 它什么都没干......
/// - important: 这很重要!
/// - warning: 警告!
/// - attention: 注意!
/// - note: 另外......没什么好说的了......
/// - version: 1.0
/// - author: Zenny Chen
 struct MyStruct {

}

上述代码例子，我们通过使用option键加鼠标左键点 击MyStruct之后会出现下图所示的文档化描述对话 框。

parameters:这个参数下面可以跟多个形参描述。
returns:这个参数后面可以对当前函数的返回值进行 描述。
throws:这个参数后面可以描述当前函数可能会抛出 某种异常。

下面我们来看两个例子。

/// 这是一个foo函数
/// - parameter obj: 一个整数对象 func foo(with obj: Int) {
}
这又是一个foo函数 - parameters:
///
///
///
///
///
///
func foo(a: Float, b: Float) throws -> Int {
- a: 左操作数
- b: 右操作数
- throws: 可能会抛出异常
- returns: 返回一个Int类型的整数对象
    return Int(a + b)
}

此外，像Objective-C中用于代码分段的 #pragma mark - 在Swift中是通过注释方式来实现的。因为 Swift中没有 #pragma 预处理器指示符，所以使用 // MARK: 来表示标记分段。我们下面来举一个简单例 子:

func myFunc() {

}
// MARK: foo函数 func foo() {
}
// MARK: test函数 func test() {
}

然后我们在函数分栏中可以看到效果

除了 // MARK: 段落标示，之外，还有 // TODO:还未完成，需要继续做的 以及 // FIXME:需要修复bug，或是测试环境，需要更改的提示。