Швидкий: Розуміння // МАРК

Яка мета написання коментарів у 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:

Він існує здебільшого для швидкої навігації у файлі.

Зауважте, що тире ( // 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() {

}