2015-04-10 2 views
1

Я просто обновился до Xcode 6.3 и имеет поддержку Swift 1.2. Я загружал быструю документацию в быстрый файл для переменной description как часть протокола Printable.Swift 1.2 Изменения документации (поддержка Markdown)

Я заметил, что в документации есть небольшой маленький встроенный блок кода. Я пока не уверен, что это было в предыдущей версии swift и было ли оно «особенным», или они добавили дополнительную поддержку функций для встроенной документации.

Кто-нибудь знает, как это сделать для моей собственной быстрой помощи?

enter image description here

Я считаю, что ObjC документация имеет гораздо больше «функции» и, возможно, так как это является частью Thats протокола ObjC почему документация «фантазии»

Update следующее:

/** 

Test Protocol Definition 

    Code Block 

**BOLD** 


*/ 

Оказывает как:

enter image description here

+0

Я помню, где-то видел, что блок документации блокирует базовую уценку. Я не могу найти ссылку. –

+0

Похоже, какая-то уценка работает ... круто! – Jeef

+0

[Таким образом, ответ] (http://stackoverflow.com/a/27766320/608157) кажется тем, что вы ищете. –

ответ

0

Таким образом, после некоторой «слежки» ближе всего я мог бы прийти к для ответа был: https://developer.apple.com/swift/blog/?id=24

Стилизованный текст легко добавить в свою игровую площадку, добавив специальную разметку для ваших комментариев на основе знакомого синтаксиса Markdown. Некоторые доступные стили являются заголовками, жирным шрифтом, курсивом, списками, пулями и ссылками на внешние или связанные ресурсы.

Хотя сообщение в блоге конкретно говорить о новых детских площадках, казалось бы, они использовали тот же визуализатор в Xcode для создания быстрой DOC/быстрозамороженной помощи (который является большим).

То, что я собрал, что следующее поддерживается

  • код блока: Отступ некоторое количество пробелов. (Поведение кажется немного темпераментным, потому что иногда это кажется просто 1 место будет работать)
  • Жирные: **
  • Курсив Текст: *

Следующие, кажется, не работает:

  • Любой вид URL Linking
  • Подчеркивание

Экспозиция уценки документ находится здесь: https://developer.apple.com/library/prerelease/ios/documentation/Swift/Reference/Playground_Ref/Chapters/MarkupReference.html однако, как видно выше, не все применимо к встроенной документации кода

+0

Спасибо. Ищете это ... – xBACP

+0

Кто-нибудь знает, есть ли Swift MarkUp с инструментом для считывания уценки в файлах реализации и выплевывания html, аналогичного тому, что Apple имела для своей версии reStructuredText? – xBACP

+0

Google jazzy doc by realm – Jeef

Смежные вопросы