使用Swift Markdown为代码编写注释

一、配置Xcode的偏好设置

快捷键command + ,打开Xcode的Preferences，找到Key Bindings，在Filter中输入Show rendered,“Show rendered Markup”用于在Playground里，切换Markdown注释的渲染。双击右侧的空白，为它设定一个快捷键command + M

Snip20180911_1.png
这样我们就可以通过Command + m快速切换markdown的渲染效果

二、如何使用?

1、在playground中基本使用

包含Markdown的单行注释用//:表示，注意使用大标题时，#和Head要有空格才能正确显示

  //:  # Head 1 

多行注释情况下使用

/*:
   * test 1
   * test 2
   * test 3
 */

Snip20180911_2.png

标记重要的地方，你可以这样写：

 /*:
 > # 注意:这里有些重要的地方需要你注意:
  通常这里是一段简单的描述.
  * item1
  * item2
  * itme3
  ---
  [More info](https://www.jianshu.com/u/f029d92cedc0)
 */

在playground渲染成这样：

Snip20180911_4.png

2、如何在多个playground之间跳转？

选中项目中的playground，右键选中New Playground Page，创建新的playground，创建的第一个命名为page2，再创建一个page3，将原先的改为page1，结构如下：

Snip20180911_5.png

新建的playground都会默认创建两个链接，分别是跳转到上一页和下一页

//: [Previous](@previous)

//: [Next](@next)

切换到渲染模式，就可以点击Previous跳转到上一页了

想要跳转到其它文件，你可以这样写：

//: [To Page3](Page3)

其它写法就是Markdown的规则了，如缩进一个制表符便可以写代码

/*:
 测试阿萨达阿萨达

    var str = "哈哈哈哈或"
    let arr = [String]()

 */

Snip20180911_6.png

其它Markdown写法在此就不过多描述了。。。