Swift：理解 // 标记

Question

在Swift中写注释的目的是什么：

// MARK: This is a comment

当你还可以做的时候：

// This is a comment

// MARK 实现了什么？

Answer 1

MARK 只是在跳转栏中添加一个视觉 MARK，如下所示：

例如// MARK: Core Data Stack

Answer 2

Swift 中的 // MARK: 和 // MARK: - 语法与 Objective-C 中的 #pragma mark 和 #pragma mark - 语法功能相同。

使用此语法（加上 // TODO: 和 // FIXME:）时，您可以获得一些额外的信息以显示在快速跳转栏中。

考虑以下几行源代码：

// MARK: A mark comment lives here.

func isPrime(_ value: UInt) -> Bool { return true }

作为参考，快速跳转栏位于 Xcode 的顶部：

它的存在主要是为了帮助在文件中快速导航。

请注意，破折号 (// MARK: -) 会导致出现一条漂亮的分隔线。考虑这个 MARK 评论：

// MARK: - A mark comment lives here.

该菜单中粗体选项上方的深灰色分隔线来自破折号。

此外，我们可以通过简单地在破折号后不包含任何文本来实现不带注释的分隔线：

// MARK: -

如前所述，// TODO: 和 // FIXME: 评论也将出现在这里。

// MARK: - Prime functions

func isPrime(_ value: UInt) -> Bool {
    // TODO: Actually implement the logic for this method
    return true
}

func nthPrime(_ value: UInt) -> Int {
    // FIXME: Returns incorrect values for some arguments
    return 2
}

FIXME 获得一个创可贴小图标，帮助他们脱颖而出。
MARK 图标看起来像 table 的内容
TODO 图标看起来更像一个清单

单击快速跳转栏中的任意行可直接转到源代码中的该行。

Swift：理解 // 标记

Swift: Understanding // MARK

xcode

comments

swift