Свифт: Понимание // МАРКА

Какова цель написания комментариев в Swift как:

// MARK: This is a comment

Когда вы также можете сделать:

// This is a comment

Что // MARKдостигается?

// MARK:И // MARK: -синтаксис функций Swift идентично #pragma markи #pragma mark -синтаксис Objective-C.

Используя этот синтаксис (плюс // TODO:и // FIXME:), вы можете получить некоторую дополнительную информацию для отображения в панели быстрого перехода.

Рассмотрим эти несколько строк исходного кода:

// MARK: A mark comment lives here.

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

И для справки, панель быстрого перехода вверху в Xcode:

Он существует в основном для быстрой навигации по файлу.

Обратите внимание, что dash ( // 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 выглядит как оглавление
• Иконки TODO больше похожи на контрольный список

Нажатие на любую строку в панели быстрого перехода приведет вас непосредственно к этой строке в исходном коде.

MARK просто добавляет визуальную метку в панель переходов следующим образом:

бывший // MARK: Core Data Stack

Вы всегда можете использовать

// 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() {

}