Комментарии к документации поддерживаются изначально в Xcode, создавая документацию в виде быстрой визуализации в Quick Help (как в popover, когда ⌥ -clicking символы, так и в Quick Help Inspector ⌥⌘2).

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

Подробные сведения о синтаксисе см. в "Обозначение форматирования разметки" . Обратите внимание, что есть некоторые расхождения между синтаксисом для богатых комментариев на игровые площадки и документацией по символам; они указаны в документе (например, кавычки могут использоваться только на игровых площадках).

Ниже приведен пример и список элементов синтаксиса, которые в настоящее время работают для комментариев документации по символам.

---

Обновления

Xcode 7 beta 4 ~ Добавлено "- Throws: ..." как элемент списка верхнего уровня, который появляется рядом с параметрами и возвращает описания в Quick Help.

Xcode 7 beta 1 ~ Некоторые существенные изменения в синтаксисе с Swift 2 - комментарии к документации теперь основаны на Markdown (такие же, как игровые площадки).

Xcode 6.3 (6D570) ~ Отложенный текст теперь отформатирован как кодовые блоки с последующими вставками. Кажется, что невозможно оставить пустую строку в таком кодовом блоке - попытка сделать это приводит к тому, что текст прикрепляется к концу последней строки с любыми символами в ней.

Xcode 6.3 beta ~ Встроенный код теперь можно добавить к комментариям документации с использованием обратных ссылок.

---

Пример для Swift 2

/// Text like this appears in "Description".
///
/// Leave a blank line to separate further text into paragraphs.
///
/// You can use bulleted lists (use `-`, `+` or `*`):
///
/// - Text can be _emphasised_
/// - Or **strong**
///
/// Or numbered lists:
///
/// 7. The numbers you use make no difference
/// 0. The list will still be ordered, starting from 1
/// 5. But be sensible and just use 1, 2, 3 etc…
///
/// ---
///
/// More Stuff
/// ==========
///
/// Code
/// ----
///
/// Use backticks for inline `code()`. Indentations of 4 spaces or more will create a code block, handy for example usage:
///
///     // Create an integer, and do nothing with it
///     let myInt = 42
///     doNothing(myInt)
///
///     // Also notice that code blocks scroll horizontally instead of wrapping.
///
/// Links & Images
/// --------------
///
/// Include [links](https://en.wikipedia.org/wiki/Hyperlink), and even images:
///
/// ![Swift Logo](/Users/Stuart/Downloads/swift.png "The logo for the Swift programming language")
///
/// - note: That "Note:" is written in bold.
/// - requires: A basic understanding of Markdown.
/// - seealso: `Error`, for a description of the errors that can be thrown.
///
/// - parameters:
///   - int: A pointless `Int` parameter.
///   - bool: This `Bool` isn't used, but its default value is `false` anyway…
/// - throws: A `BadLuck` error, if you're unlucky.
/// - returns: Nothing useful.
func doNothing(int: Int, bool: Bool = false) throws -> String {
    if unlucky { throw Error.BadLuck }
    return "Totally contrived."
}

---

Синтаксис для Swift 2 (на основе Markdown)

Стиль комментариев

Для комментариев документации поддерживаются теги /// (inline) и /** */ (block) style. Хотя я лично предпочитаю визуальный стиль комментариев /** */, автоматический отступ Xcode может испортить форматирование для этого стиля комментариев при копировании/вставке, поскольку он удаляет ведущие пробелы. Например:

/**
See sample usage:

    let x = method(blah)
*/

При вставке отступ блока кода удаляется, и он больше не отображается как код:

/**
See sample usage:

let x = method(blah)
*/

По этой причине я обычно использую /// и буду использовать его для остальных примеров в этом ответе.

Элементы блока

Заголовок:

/// # My Heading

или

/// My Heading
/// ==========

Подзаголовок:

/// ## My Subheading

или

/// My Subheading
/// -------------

Горизонтальное правило:

/// ---

Неупорядоченные (маркированные) списки:

/// - An item
/// - Another item

Вы также можете использовать + или * для неупорядоченных списков, это просто должно быть согласованным.

Упорядоченные (нумерованные) списки:

/// 1. Item 1
/// 2. Item 2
/// 3. Item 3

Блоки кода:

///    for item in array {
///        print(item)
///    }

Требуется отступ не менее четырех пробелов.

Встроенные элементы

Акцент (курсив):

/// Add like *this*, or like _this_.

Сильный (жирный):

/// You can **really** make text __strong__.

Обратите внимание, что вы не можете смешивать звездочки (*) и подчеркивания (_) на одном и том же элементе.

Встроенный код:

/// Call `exampleMethod(_:)` to demonstrate inline code.

Ссылки:

/// [Link Text](https://en.wikipedia.org/wiki/Hyperlink)

Изображения:

/// ![Alt Text](http://www.example.com/alt-image.jpg)

URL-адрес может быть либо веб-URL (с использованием "http://" ), либо абсолютным URL-адресом пути к файлу (я не могу заставить обрабатывать относительные пути к файлу).

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

/// A [link][1] an an ![image][2]
///
/// ...
///
/// [1]: http://www.example.com
/// [2]: http://www.example.com/image.jpg

Ключевые слова

В дополнение к форматированию Markdown Xcode распознает другие ключевые слова разметки, чтобы они отображались в Quick Help. Эти ключевые слова разметки в основном принимают формат - <keyword>: (исключение parameter, которое также включает имя параметра перед двоеточием), где само ключевое слово может быть записано с любой комбинацией символов верхнего и нижнего регистра.

Ключевые слова раздела символов

Следующие ключевые слова отображаются в виде заметных разделов в средстве просмотра справки, ниже раздела "Описание" и над разделом "Объявлено в". При включении их порядок фиксируется, как показано ниже, даже если вы можете включить их в любом порядке, который вам нравится в ваших комментариях.

См. полностью задокументированный список ключевых слов раздела и их предполагаемое использование в разделе "Команды разделов символов" в разделе "Обозначение форматирования разметки" .

/// - parameters:
///   - <#parameter name#>:
///   - <#parameter name#>:
/// - throws:
/// - returns:

В качестве альтернативы вы можете записать каждый параметр следующим образом:

/// - parameter <#parameter name#>:

Символ Описание Ключевые слова поля

Следующий список ключевых слов отображается в жирным заголовкам в теле раздела "Описание" в средстве просмотра справки. Они появятся в том порядке, в котором вы их записываете, как и в остальной части раздела "Описание" .

Полный список перефразирован из этой превосходной статьи в блоге Эрика Садун. Также просмотрите полностью задокументированный список ключевых слов и их предполагаемое использование в разделе в разделе "Команды полей описания символа" в разделе "Обозначение форматирования разметки" .

атрибуции:

/// - author:
/// - authors:
/// - copyright:
/// - date:

Наличие:

/// - since:
/// - version:

увещевания:

/// - attention:
/// - important:
/// - note:
/// - remark:
/// - warning:

Состояние разработки:

/// - bug:
/// - todo:
/// - experiment:

Качества реализации:

/// - complexity:

Функциональная семантика:

/// - precondition:
/// - postcondition:
/// - requires:
/// - invariant:

Перекрестная ссылка:

/// - seealso:

---

Экспорт документации

Документация HTML (предназначенная для имитации собственной документации Apple) может быть создана из встроенной документации, используя Jazzy, утилиту командной строки с открытым исходным кодом.

$ [sudo] gem install jazzy
$ jazzy
Running xcodebuild
Parsing ...
building site
jam out ♪♫ to your fresh new docs in `docs`

Пример консоли, взятый из этой статьи NSHipster