Swift 1.2文档更改（Markdown支持）

时间：2015-04-10 16:46:31

标签： ios swift

我刚刚升级到Xcode 6.3并且它支持Swift 1.2。作为description协议的一部分，我在Printable变量的swift文件中加载了快速文档。

我注意到文档有一个很好的内联代码块。我还不确定是否在之前版本的swift中存在这种情况，以及它是否是特殊的＆＃34;或者他们为内联文档添加了更多功能支持。

任何人都知道如何为我自己的快速帮助做到这一点？

enter image description here

我相信Obj-c文档有更多＆＃34;功能＆＃34;也许因为这是Objc协议的一部分，这就是为什么文档是＆＃34;幻想＆＃34;

更新以下内容：

/** 

Test Protocol Definition

    Code Block

**BOLD**


*/

呈现为：

enter image description here

1 个答案:

答案 0 :(得分：1)

经过一些＆＃34;调查＆＃34;我能找到最接近答案的地方是：https://developer.apple.com/swift/blog/?id=24

根据熟悉的Markdown语法，通过在评论中添加特殊标记，可以轻松地将样式化文本添加到游乐场。一些可用的样式是标题，粗体，斜体，列表，项目符号以及指向外部或捆绑资源的链接。

虽然博客文章专门讨论了新的 Playgrounds ，但似乎他们在Xcode中使用了相同的渲染器来生成quick-doc / quick-help（这很棒）。

我收集的内容是支持以下内容

  • 代码块：缩进一些空格。 （行为似乎有点气质，因为有时看起来只有1个空间会起作用）
  • 粗体文字：**
  • 斜体文字：*

以下似乎不起作用：

  • 任何类型的网址链接
  • 下划线

Playground markdown文档在这里：https://developer.apple.com/library/prerelease/ios/documentation/Swift/Reference/Playground_Ref/Chapters/MarkupReference.html但是如上所示，并非所有内容都适用于代码的内联文档

相关问题
最新问题