Swift: zrozumienie // MARK

Jaki jest cel pisania komentarzy w Swift jako:

// MARK: This is a comment

Kiedy możesz też:

// This is a comment

Co to daje // MARK?

// MARK:I // MARK: -składni w funkcji Swift identycznie #pragma marki #pragma mark -składni w celu C.

Używając tej składni (plus // TODO:i // FIXME:), możesz uzyskać dodatkowe informacje, które pojawią się na pasku szybkiego przeskoku.

Rozważ kilka wierszy kodu źródłowego:

// MARK: A mark comment lives here.

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

Dla porównania pasek szybkiego przeskoku znajduje się na górze w Xcode:

Istnieje głównie po to, aby pomóc w szybkiej nawigacji w pliku.

Zauważ, że myślnik ( // MARK: -) powoduje wyświetlenie ładnej linii oddzielającej. Rozważ ten MARKkomentarz:

// MARK: - A mark comment lives here.

Ciemnoszara linia separatora tuż nad pogrubioną opcją w tym menu pochodzi z myślnika.

Dodatkowo możemy osiągnąć tę linię separatora bez komentarza, po prostu nie mając żadnego tekstu po myślniku:

// MARK: -

Jak już wspomniano, // TODO:i // FIXME:komentarze pojawi się również tutaj.

// 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 otrzymują małą ikonę pomocy zespołu, która pomaga im się wyróżniać.
• Ikona MARK wygląda jak spis treści
• Ikony TODO wyglądają bardziej jak lista kontrolna

Kliknięcie dowolnej linii na pasku szybkiego przeskoku powoduje przejście bezpośrednio do tej linii w kodzie źródłowym.

MARK po prostu dodaje wizualny ZNAK w pasku skoku w następujący sposób:

dawny // MARK: Core Data Stack

Zawsze możesz użyć

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

}