Dans l'Objectif C, je peux utiliser #pragma markpour marquer des sections de mon code dans le navigateur de symboles. Comme il s'agit d'une commande de préprocesseur C, elle n'est pas disponible dans Swift. Y a-t-il un remplaçant pour cela dans Swift, ou dois-je utiliser des commentaires laids?

Vous pouvez utiliser // MARK:

Il a également été discuté que l'utilisation libérale des extensions de classe pourrait être une meilleure pratique de toute façon. Étant donné que les extensions peuvent implémenter des protocoles, vous pouvez, par exemple, mettre toutes vos méthodes de délégué de vue de table dans une extension et regrouper votre code à un niveau plus sémantique que ce qui #pragma markest possible.

Jusqu'à Xcode 5, la directive du préprocesseur #pragma markexistait.

A partir de Xcode 6, vous devez utiliser // MARK:

Ces fonctionnalités de préprocesseur permettent d'apporter une certaine structure à la liste déroulante des fonctions de l'éditeur de code source.

quelques exemples :

// MARK:

-> sera précédé d'un séparateur horizontal

// MARK: your text goes here

-> met 'votre texte va ici' en gras dans la liste déroulante

// MARK: - your text goes here

-> met 'votre texte va ici' en gras dans la liste déroulante, précédé d'un séparateur horizontal

mise à jour: capture d'écran ajoutée, car certaines personnes semblent toujours avoir des problèmes avec ceci:

Pour ceux qui souhaitent utiliser des extensions par rapport aux marques pragma (comme mentionné dans le premier commentaire), voici comment l'implémenter à partir d'un ingénieur Swift:

import UIKit

class SwiftTableViewController: UITableViewController {

    init(coder aDecoder: NSCoder!) {
        super.init(coder: aDecoder)

    }

    override func viewDidLoad() {
        super.viewDidLoad()

    }
}

extension SwiftTableViewController {
    override func numberOfSectionsInTableView(tableView: UITableView?) -> Int {
        return 1
    }

    override func tableView(tableView: UITableView?, numberOfRowsInSection section: Int) -> Int {
        return 5
    }

    override func tableView(tableView: UITableView?, cellForRowAtIndexPath indexPath: NSIndexPath?) -> UITableViewCell? {
        let cell = tableView?.dequeueReusableCellWithIdentifier("myCell", forIndexPath: indexPath) as UITableViewCell;

        cell.textLabel.text = "Hello World"

        return cell
    }

}

Ce n'est pas non plus nécessairement la meilleure pratique, mais c'est ainsi que vous le faites si vous le souhaitez.

Pragma mark - [SOME TEXT HERE]a été utilisé dans Objective-C pour regrouper plusieurs fonctions par séparation de lignes.

Dans Swift, vous pouvez y parvenir en utilisantMARK, TODO OR FIXME

je. MARQUE : //MARK: viewDidLoad

Cela va créer une ligne horizontale avec des fonctions regroupées sous viewDidLoad (montré dans la capture d'écran 1)

ii. FAIRE : //TODO: - viewDidLoad

Cela regroupera la fonction sous TODO: - catégorie viewDidLoad (montré dans la capture d'écran 2)

iii. RÉPARE-MOI : //FIXME - viewDidLoad

Cela regroupera la fonction sous FIXME: - catégorie viewDidLoad (montré dans la capture d'écran 3)

Consultez cette documentation Apple pour plus de détails.

Documentation officielle

Document officiel d'Apple sur Xcode Jump Bar: ajouter des annotations de code à la barre de saut

Captures d'écran de la barre de saut pour un exemple de code

Comportement dans Xcode 10.1 et macOS 10.14.3 (Mojave)

Comportement dans Xcode 10.0 et macOS 10.13.4 (High Sierra)

Comportement dans Xcode 9.4.1 et macOS 10.13.0

Discussion

!!!:et ???:parfois ne peuvent pas être affichés.

Dans le code Objective-C, Xcode détecte des commentaires comme celui // MARK: - fooqui est un peu plus portable que #pragma. Mais ceux-ci ne semblent pas non plus être repris (encore?).

Edit: corrigé dans Xcode 6 beta 4.

Je pense que Extensionsc'est une meilleure façon de le faire #pragma mark.

Le code avant d'utiliser Extensions:

class ViewController: UIViewController, UICollectionViewDataSource, UICollectionViewDelegate {
    ...

    func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
        ...
    }

    func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
        ...
    }

    func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
        ...
    }
}

Le code après utilisation Extensions:

class ViewController: UIViewController {
    ...
}

extension ViewController: UICollectionViewDataSource {
    func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
        ...
    }

    func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
        ...
    }
}

extension ViewController: UICollectionViewDelegate {
    func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
       ...
    }
}

Xcode 8 le gère maintenant comme suit et apparaît comme ceci dans le menu déroulant de la méthode:

Confirmé avec un ingénieur Apple dans le laboratoire Swift ce matin à la WWDC qu'il n'y a actuellement pas de #pragma ou équivalent pour le moment, ils considèrent cela comme un bug, et il arrivera bientôt, donc je suppose que la bêta 2, j'espère.

Quoi qu'il en soit, c'est en route.

Xcode prend désormais en charge les repères // MARK :, // TODO: et // FIXME pour annoter votre code et les répertorier dans la barre de saut

Il y a trois options à ajouter #pragma_markdans Swift:

1) // MARK: - your text here -

2) // TODO: - your text here -

3) // FIXME: - your text here -

Remarque: utilise -pour ajouter des séparateurs

Utilisation

// MARK: SectionName

ou

// MARK: - SectionName

Cela donnera une ligne au-dessus de la marque pragma, la rendant plus lisible.

Pour plus de facilité, ajoutez simplement

// MARK: - <#label#>

à vos extraits de code.

Autre moyen -

Utilisez-le de cette façon

private typealias SectionName = ViewController
private extension SectionName  {
    // Your methods
}

Cela ajoutera non seulement une marque (tout comme la marque pragma) mais séparera également le code.

//# MARK: - Spinner Class Methods

Ajoutez une ligne entre les deux points et votre description pour insérer une ligne de séparation. Cela permet d'organiser encore plus votre code. Le code et la capture d'écran ci-dessus utilisent le commentaire MARK avec une ligne incluse.

1. // # MARK: - Méthodes de texte (LINE)
2. // # MARK: Méthodes de texte (PAS DE LIGNE)

Cela ne fonctionne qu'avec le commentaire MARK.

Vous pouvez également être intéressé par les directives du compilateur Swift 4.2 / XCode 10 comme

#warning("Some string to display")

et

#error("Some error to display")

Cela peut être utile lorsque vous ne voulez vraiment rien manquer.

Le programmeur professionnel doit utiliser cette balise pour obtenir un bon code. C'est aussi bon pour le travail d'équipe.

// MARK: example Web Service start here
// TODO: example 1
// FIXME: Please change BASE url before live 

Il est facile de trouver une méthode comme celle-ci

Dans Xcode 11, ils ont ajouté une mini-carte qui peut être activée Editor -> Minimap.

La mini-carte affichera chaque texte de marque pour une orientation rapide dans le code. Chaque marque est écrite comme// MARK: Variables

//MARK:ne semble pas fonctionner pour moi dans Xcode 6.3.2. Cependant, c'est ce que j'ai fait pour le faire fonctionner :

1) Code:

import Cocoa

class MainWindowController: NSWindowController {

    //MARK: - My cool methods

    func fly() {
    }

    func turnInvisible() {

    }
}

2) Dans le jump barrien ne semble changer lors de l'ajout du //MARK: commentaire. Cependant, si je clique sur le nom le plus à droite dans la barre de saut, dans mon cas, il est dit MainWindowController(with a leading C icon), alors une fenêtre contextuelle s'affichera montrant les effets du commentaire // MARK:, à savoir un titre qui dit "Mes méthodes cool":

3) Je remarque également que si je clique sur l'une des méthodes de mon code, la méthode devient l'entrée la plus à droite dans la barre de saut. Pour arriver MainWindowController(with a leading C icon)à être l'entrée la plus à droite dans la barre de saut, je dois cliquer sur l'espace au-dessus de mes méthodes.

Apple déclare dans la dernière version de Building Cocoa Apps ,

Le compilateur Swift ne comprend pas de préprocesseur. Au lieu de cela, il tire parti des attributs au moment de la compilation, des configurations de génération et des fonctionnalités de langage pour accomplir la même fonctionnalité. Pour cette raison, les directives de préprocesseur ne sont pas importées dans Swift.

Le caractère # semble toujours être la façon dont vous travaillez avec diverses configurations de construction et des choses comme ça, mais il semble qu'ils essaient de réduire votre besoin de pré-traitement dans la veine de Pragma et de vous transmettre à d'autres fonctionnalités de langage. Peut-être est-ce pour aider au fonctionnement des Playgrounds et du REPL se comportant le plus près possible du code entièrement compilé.

Ajouter un élément à faire: insérer un commentaire avec le préfixe TODO :. Par exemple: // TODO: [votre tâche à faire].

Ajouter un rappel de correction de bogue: Insérez un commentaire avec le préfixe FIXME :. Par exemple: // FIXME: [votre rappel de correction de bogue].

Ajouter un en-tête: insérez un commentaire avec le préfixe MARK :. Par exemple: // MARK: [votre en-tête de section].

Ajouter une ligne de séparation: pour ajouter un séparateur au-dessus d'une annotation, ajoutez un trait d'union (-) avant la partie commentaire de l'annotation. Par exemple: // MARK: - [votre contenu]. Pour ajouter un séparateur sous une annotation, ajoutez un trait d'union (-) après la partie commentaire de l'annotation. Par exemple: // MARK: [votre contenu] -.

Essaye ça:

// MARK: Reload TableView

func reloadTableView(){

    tableView.reload()
}

La marque Pragma est un moyen d'améliorer la lisibilité de votre code. Les commentaires du pragma apparaîtront comme des balises sur la barre de saut Xcode.

//MARK:  <Your comment goes here>

Exemple: dans le code,

//MARK: Properties

// MARK: View Life cycle

//MARK: Helper methods

Voici comment cela apparaîtrait dans la barre de saut Xcode.