使用Swift Markdown为代码编写注释

一、配置Xcode的偏好设置

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

Snip20180911_1.png

这样我们就可以通过option + 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写法在此就不过多描述了。。。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明AI阅读 16,060评论 3 119
  • 自定义我把它分为简单的三个步骤, 1.创建组件 --- 2.编写组件 --- 3.调用,使用组件. 1.1 创建组...
    _conquer_阅读 2,885评论 0 0
  • 【成图背景介绍】 作者:Angelababy(英文名),是我的宝贝女儿,是一名普通的小学生。在她七岁零八个月,暑假...
    苗苗老师思维导图阅读 15,096评论 17 30
  • Markdown是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用。看到这里请...
    xiechengfa阅读 3,177评论 1 2
  • 学分,奖学金,名誉,钱财这些东西是永远追不完的。而且这些东西是不能长久的。要想得到长久的快乐,必须把一些长久的东西...
    Healer1234阅读 1,445评论 0 0

友情链接更多精彩内容