在 Xcode 7 當中,Playground 允許我們使用類似 Markdown 語法來對代碼進行具有格式的富文本註釋,現在,我們就來簡單介紹一下如何對文本進行富文本註釋。
如何編輯富文本註釋
打開你的 Xcode 7,在 Playground 中,選擇菜單欄中的 Editor > Show Raw Markup 來讓富文本註釋顯示為純文本模式,這樣它們就變得可編輯了。再次進行這個步驟就可以恢復。
語法
我們這裡先規定幾個佔位符,然後再來介紹具體的語法:
<有效的 標記 向上 文本> | 任意合法的註釋內容。 |
<可選的 評論> | 這段代碼用來給富文本註釋進行註釋,只會在純文本的編輯模式下才會顯示。 |
<串> | 一行文字,開頭和結尾的字符不能是空格。 |
<整數> | 任意合法的整數。 |
<空白的 線> | 空行。 |
單行註釋
1 |
//: <valid marked up text> |
與普通的註釋比起來,就是雙斜杠後邊多了一個冒號。
多行合併
進行多個單行註釋,如果兩個單行註釋相連,那麼它們就會自動地組成一個註釋塊。
舉個栗子:
1 2 3 4 |
//: This is a line of text that will appear as a rich comment in a playground. //: These two lines of single delimiter text //: show up as one rich comment block in the playground |
這是效果:
註釋塊
我們同樣可以給註釋塊使用富文本註釋,與普通的註釋塊不同的是,開頭的 /* 後邊也要加上冒號,類似這樣: /*:
1 2 3 4 5 6 7 8 9 |
/*: <optional comment> <valid marked up text> <valid marked up text> … */ |
我們來舉個栗子:
1 2 3 4 |
/*: 在富文本模式下这一行不会显示。 # The First Heading Shown The first content line displayed in this block of rich text. */ |
這是效果圖:
格式化元素
標題
與 Markdown 一樣,我們用井號 # 來標記標題,標題內容與井號至少有一個空格的距離。一個 # 是一級標題,兩個 # 就是二級標題……以此類推。
標題 1 | # <串> |
標題 2 | ## <串> |
標題 3 | ### <串> |
舉個栗子:
1 |
//: ## This is a Heading 2 |
這是效果圖:
另一種選擇
對於一級和二級標題來講,我們還有另外一種選擇可以使用:
標題 1 |
<串>
=<重複 對於 特點 計數 的 標題 串> 使用等於號給一級標題做下劃線 ( =). 等於號的長度必須與標題字符長度等長。 |
標題 2 |
<串>
-<重複 對於 特點 計數 的 標題 串> 使用連字符來給二級標題做下劃線 ( -). 連字符也得和標題長度等長才行。 |
舉個栗子:
1 2 |
//: This is a Heading 1 //: =================== |
這是效果:
項目列表
我們使用星號 * 來標記項目列表,星號與列表文字間隔一個空格:
1 |
* <string> |
舉個栗子:
1 2 3 4 |
/*: 带有两个元素的项目列表 * Item 1 * Item 2 */ |
這是效果:
數字順序列表
這個不多說了,直接看例子吧,很好理解:
一級列表 | <整數>. <串> |
二級列表 |
<整數>. <串>
4 個空格 |
三級列表 |
<整數>. <串>
8 個空格 |
栗子:
1 2 3 4 5 6 |
/*: 带有二级的数字列表 1. Cat 2. Dog 1. Golden Retriever 3. Llama */ |
效果:
引用文字
使用一個大於號來標記引用文字,記得加空格!
1 |
> <string> |
舉個栗子:
1 2 3 4 5 6 |
/*: 一段来自 Aesop's Fables 的内容 > The Swallow and the Crow had a contention about their plumage. > The Crow put an end to the dispute by saying, > "Your feathers are all very well in the spring, > but mine protect me against the winter." */ |
效果:
水平分割線
使用4個以上的連字符來標記水平分割線,記得上下有空行!
1 2 3 4 5 |
<blank line> ---- <blank line> |
舉個栗子:
1 2 3 4 5 |
/*: 水平线 ---- */ |
效果:
字體效果
斜體
以下二者都可
1 2 3 |
*<string>* _<string>_ |
舉個栗子:
1 2 3 |
//: This line has a word with *emphasis*. //: This line uses _emphasis for the last six words_. |
這是效果:
粗體字
以下兩者均可
1 2 3 |
**<string>** __<string>__ |
舉個栗子:
1 2 3 |
//: A **strong * (asterisk)** is on this line. //: __A strong line__. |
效果:
如此的一些語法,應該已經足夠日常使用,更多的比如添加鏈接、插入圖片等等的高級使用這裡就不做介紹了,如果想要了解這些內容,請移步遊樂場標記格式註釋
本文由 落格博客 原創撰寫:落格博客 » 在 Playground 中使用 富文本註釋
轉載請保留出處和原文鏈接:https://www.logcg.com/archives/1058.html