Swift: Comprendre // MARK

Quel est le but d'écrire des commentaires dans Swift comme:

// MARK: This is a comment

Quand vous pouvez également faire:

// This is a comment

Que réalise-t-il // MARK?

La syntaxe // MARK:et // MARK: -dans Swift fonctionne de la même manière que la syntaxe #pragma market #pragma mark -dans Objective-C.

Lorsque vous utilisez cette syntaxe (plus // TODO:et // FIXME:), vous pouvez obtenir des informations supplémentaires à afficher dans la barre de saut rapide.

Considérez ces quelques lignes de code source:

// MARK: A mark comment lives here.

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

Et pour référence, la barre de saut rapide est en haut dans Xcode:

Il existe principalement pour aider à une navigation rapide dans le fichier.

Notez que le tiret ( // MARK: -) fait apparaître une belle ligne de séparation. Considérez ce MARKcommentaire:

// MARK: - A mark comment lives here.

La ligne de séparation gris foncé juste au-dessus de l'option en gras dans ce menu provient du tiret.

De plus, nous pouvons réaliser cette ligne de séparation sans commentaire en n'ayant simplement aucun texte après le tiret:

// MARK: -

Comme mentionné, // TODO:et les // FIXME:commentaires apparaîtront également ici.

// 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
}

• Les FIXME reçoivent une petite icône de pansement qui les aide à se démarquer.
• L'icône MARQUE ressemble à une table des matières
• Les icônes TODO ressemblent plus à une liste de contrôle

Cliquer sur n'importe quelle ligne dans la barre de saut rapide vous amène directement à cette ligne dans le code source.

MARK ajoute simplement un MARK visuel dans la barre de saut comme ceci:

ex // MARK: Core Data Stack

Vous pouvez toujours utiliser

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

}