Markdown在Xcode中的应用

Xcode在playground和源代码中对markdown有不同的渲染格式。

command + ,打开属性对话框,key bindings搜索show render markup,设置键位切换playground和源码注释渲染效果

在playground中markdown格式以:开头,在源码中,单行注释用///开头,多行注释以* 开头,起始字符有区别。

源码中:

struct IntArray {

/// A **demo** function

func demo(){}

/**

listDemo

* item1 在多行注释的后面多加一个*号,表示支持markdown的多行注释

* item2 列表项不能出现在第一行

* item3 为了渲染成功,必须加空格或者在第一行用文字代替

*/

func listDemo(){}

}


源码注释格式

playground中:

单行注释后添加冒号的格式使用markdown      //:

//: [Previous](@previous)

import Foundation

var str = "Hello, playground"

//: # headingOne1

/*:

* item1

* item2

* item3

*/

//: [Next](@next)


playground注释格式

然后option+M也就是刚才设置的快捷键进行渲染,效果如图


常用注释范式:

将需要的注释生成代码片段,需要自行定义的地方用<# #>括起来,选中所有注释代码,拖动到snippet library中,双击预览,edit编辑信息,以后只要输入自己定义的代码片段名称就可以直接使用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容