Swift:了解// MARK

Question

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

// MARK: This is a comment

当您还可以这样做时：

// This is a comment

// MARK实现了什么？

Answer 1

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获得一个小小的创可贴图标来帮助他们standout.
• MARK图标看起来像contents
• TODO图标的表格看起来更像一张清单

单击快速跳转栏中的任何一行都可以直接转到源代码中的这一行。

Answer 2

MARK只需在跳转条中添加一个可视化的MARK，如下所示：

ex // MARK: Core Data Stack

​

​

Answer 3

你可以随时使用

// MARK: - Properties
var name: String

// MARK: - Methods
func display() {
}

init(name: String, rollNumber: Int) {

    // TODO: add configuration code
    self.name = name
}

// FIXME: bug XYZ
func fixBug() {

}