В Objective C я могу использовать #pragma markдля маркировки разделов моего кода в навигаторе символов. Так как это команда препроцессора C, она не доступна в Swift. Есть ли замена для этого в Swift, или я должен использовать уродливые комментарии?

Ты можешь использовать // MARK:

Также было обсуждение, что либеральное использование расширений классов могло бы быть лучшей практикой в ​​любом случае. Поскольку расширения могут реализовывать протоколы, вы можете, например, поместить все методы делегата табличного представления в расширение и сгруппировать ваш код на более семантическом уровне, чем #pragma markэто возможно.

До Xcode 5 #pragma markсуществовала директива препроцессора .

Начиная с Xcode 6, вы должны использовать // MARK:

Эти возможности препроцессора позволяют внести некоторую структуру в раскрывающийся список функций редактора исходного кода.

Некоторые примеры :

// MARK:

-> будет предшествовать горизонтальный разделитель

// MARK: your text goes here

-> ставит «ваш текст идет здесь» жирным шрифтом в раскрывающемся списке

// MARK: - your text goes here

-> в раскрывающемся списке выделяет жирным шрифтом слово «ваш текст», которому предшествует горизонтальный разделитель

обновление: добавлен скриншот, потому что у некоторых людей все еще есть проблемы с этим:

Для тех, кто заинтересован в использовании расширений против прагматических отметок (как упомянуто в первом комментарии), вот как реализовать это из Swift Engineer:

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
    }

}

Это также не обязательно лучшая практика, но это то, как вы делаете это, если хотите.

Pragma mark - [SOME TEXT HERE]был использован в Objective-C для группировки нескольких функций с помощью разделения строк.

В Swift вы можете добиться этого, используяMARK, TODO OR FIXME

я. ОТМЕТКА : //MARK: viewDidLoad

Это создаст горизонтальную линию с функциями, сгруппированными под viewDidLoad (показано на скриншоте 1)

II. ДЕЛАТЬ : //TODO: - viewDidLoad

Это сгруппирует функцию под TODO: - категория viewDidLoad (показано на скриншоте 2)

III. ИСПРАВИТЬ МЕНЯ : //FIXME - viewDidLoad

Это сгруппирует функцию в FIXME: - категория viewDidLoad (показано на скриншоте 3)

Проверьте эту яблочную документацию для деталей.

Официальная документация

Официальный документ Apple о панели переходов Xcode: добавление аннотаций кода в панель переходов

Скриншоты Jump Bar для примера кода

Поведение в Xcode 10.1 и macOS 10.14.3 (Мохаве)

Поведение в Xcode 10.0 и macOS 10.13.4 (High Sierra)

Поведение в Xcode 9.4.1 и macOS 10.13.0

обсуждение

!!!:и ???:иногда не могут быть отображены.

В коде Objective-C Xcode обнаруживает такие комментарии, // MARK: - fooкоторые немного более переносимы, чем #pragma. Но они, похоже, тоже не подобраны (пока?).

Редактировать: Исправлено в Xcode 6 beta 4.

Я думаю, что Extensionsэто лучший способ вместо #pragma mark.

Код перед использованием 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) {
        ...
    }
}

Код после использования 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 теперь обрабатывает это следующим образом и выглядит следующим образом в раскрывающемся списке методов:

Этим утром в WWDC в лаборатории Swift подтвердили инженеру Apple, что в данный момент нет #pragma или его эквивалента, они считают это ошибкой, и она скоро появится, так что, я надеюсь, бета 2, я надеюсь.

Во всяком случае, это на своем пути.

Xcode теперь поддерживает ориентиры // MARK :, // TODO: и // FIXME, чтобы комментировать ваш код и перечислять их в панели переходов

В #pragma_markSwift можно добавить три варианта :

1) // MARK: - your text here -

2) // TODO: - your text here -

3) // FIXME: - your text here -

Примечание: использует -для добавления разделителей

использование

// MARK: SectionName

или

// MARK: - SectionName

Это даст строку выше отметки прагмы, делая ее более читабельной.

Для удобства просто добавьте

// MARK: - <#label#>

к вашим фрагментам кода.

Альтернативный способ -

Используйте это таким образом

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

Это не только добавит метку (точно так же, как метка прагмы), но и хорошо разделит код.

//# MARK: - Spinner Class Methods

Добавьте строку между двоеточием и вашим описанием, чтобы вставить разделительную строку. Это помогает организовать ваш код еще больше. Приведенный выше код и снимок экрана используют комментарий MARK со строкой.

1. // # MARK: - Методы текста (LINE)
2. // # MARK: текстовые методы (NO LINE)

Это работает только с комментарием MARK.

Вы также можете быть заинтересованы в директивах компилятора Swift 4.2 / XCode 10, таких как

#warning("Some string to display")

а также

#error("Some error to display")

Это может быть полезно, когда вы действительно не хотите что-то пропустить.

Профессиональный программист должен использовать этот тег для хорошего кода. Это также хорошо для командной работы.

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

Подобный метод легко найти

В Xcode 11 они добавили миникарту, которую можно активировать Editor -> Minimap.

Миникарта покажет каждый текст пометки для быстрой ориентации в коде. Каждый знак написан как// MARK: Variables

//MARK:не похоже , чтобы работать для меня в Xcode 6.3.2. Тем не менее, вот что я сделал, чтобы заставить его работать :

1) код:

import Cocoa

class MainWindowController: NSWindowController {

    //MARK: - My cool methods

    func fly() {
    }

    func turnInvisible() {

    }
}

2) При jump barдобавлении //MARKкомментария ничего не отображается . Однако, если я нажму на крайнее правое имя в панели переходов, в моем случае это говорит о том MainWindowController(with a leading C icon), что появится всплывающее окно с эффектом комментария // MARK: а именно заголовок, который говорит: «Мои классные методы»:

3) Я также заметил, что если я нажму на один из методов в моем коде, то этот метод станет самой правой записью в панели переходов. Чтобы MainWindowController(with a leading C icon)стать самой правой записью в панели переходов, я должен щелкнуть пробел над моими методами.

Apple , говорится в последней версии Building какао приложения ,

Компилятор Swift не включает препроцессор. Вместо этого он использует преимущества атрибутов времени компиляции, конфигураций сборки и языковых функций для достижения той же функциональности. По этой причине директивы препроцессора не импортируются в Swift.

Кажется, что символ # по-прежнему является тем, как вы работаете с различными конфигурациями сборки и тому подобными вещами, но похоже, что они пытаются сократить ваши потребности в большей части предварительной обработки в духе прагмы и перенаправить вас на другие языковые функции в целом. Возможно, это поможет игровым площадкам и REPL вести себя как можно ближе к полностью скомпилированному коду.

Добавить элемент списка дел: вставить комментарий с префиксом TODO :. Например: // TODO: [ваш список дел].

Добавьте напоминание об исправлении ошибки: вставьте комментарий с префиксом FIXME :. Например: // FIXME: [ваше напоминание об исправлении ошибки].

Добавить заголовок: вставить комментарий с префиксом MARK :. Например: // MARK: [заголовок вашего раздела].

Добавить разделительную линию. Чтобы добавить разделитель над аннотацией, добавьте дефис (-) перед частью комментария к аннотации. Например: // MARK: - [ваш контент]. Чтобы добавить разделитель ниже аннотации, добавьте дефис (-) после части комментария аннотации. Например: // MARK: [ваш контент] -.

Попробуй это:

// MARK: Reload TableView

func reloadTableView(){

    tableView.reload()
}

Прагма - это способ улучшить читабельность вашего кода. Комментарии прагмы выглядят как теги на панели переходов Xcode.

//MARK:  <Your comment goes here>

Пример: в коде

//MARK: Properties

// MARK: View Life cycle

//MARK: Helper methods

Вот как это будет выглядеть в панели переходов Xcode.