分類
Swift

在 Playground 中使用 富文本註釋

在 Xcode 7 當中,Playground 允許我們使用類似 Markdown 語法來對代碼進行具有格式的富文本註釋,現在,我們就來簡單介紹一下如何對文本進行富文本註釋。

如何編輯富文本註釋

打開你的 Xcode 7,在 Playground 中,選擇菜單欄中的 Editor > Show Raw Markup 來讓富文本註釋顯示為純文本模式,這樣它們就變得可編輯了。再次進行這個步驟就可以恢復。

語法

我們這裡先規定幾個佔位符,然後再來介紹具體的語法:

<valid marked up text> 任意合法的註釋內容。
<optional comment> 這段代碼用來給富文本註釋進行註釋,只會在純文本的編輯模式下才會顯示。
<string> 一行文字,開頭和結尾的字符不能是空格。
<integer> 任意合法的整數。
<blank line> 空行。

單行註釋

與普通的註釋比起來,就是雙斜杠後邊多了一個冒號。

多行合併

進行多個單行註釋,如果兩個單行註釋相連,那麼它們就會自動地組成一個註釋塊。

舉個栗子:

這是效果:

單行註釋自動合併
單行註釋自動合併

註釋塊

我們同樣可以給註釋塊使用富文本註釋,與普通的註釋塊不同的是,開頭的 /* 後邊也要加上冒號,類似這樣: /*:

我們來舉個栗子:

這是效果圖:

富文本註釋塊
富文本註釋塊

格式化元素

標題

與 Markdown 一樣,我們用井號 # 來標記標題,標題內容與井號至少有一個空格的距離。一個 # 是一級標題,兩個 # 就是二級標題……以此類推。

標題 1 # <string>
標題 2 ## <string>
標題 3 ### <string>

舉個栗子:

這是效果圖:

註釋一個二級標題
註釋一個二級標題

 

另一種選擇

對於一級和二級標題來講,我們還有另外一種選擇可以使用:

標題 1 <string>

=<repeat for character count of heading string>

使用等於號給一級標題做下劃線 (=).

等於號的長度必須與標題字符長度等長。

標題 2 <string>

-<repeat for character count of heading string>

使用連字符來給二級標題做下劃線 (-).

連字符也得和標題長度等長才行。

舉個栗子:

這是效果:

添加一個一級標題
添加一個一級標題

項目列表

我們使用星號 * 來標記項目列表,星號與列表文字間隔一個空格:

舉個栗子:

這是效果:

帶有兩個元素的項目列表
帶有兩個元素的項目列表

數字順序列表

這個不多說了,直接看例子吧,很好理解:

一級列表 <integer>. <string>
二級列表 <integer>. <string>

4 個空格

三級列表 <integer>. <string>

8 個空格

栗子:

效果:

帶有二級的數字列表
帶有二級的數字列表

引用文字

使用一個大於號來標記引用文字,記得加空格!

舉個栗子:

效果:

一段來自 Aesop's Fables 的內容
一段來自 Aesop’s Fables 的內容

水平分割線

使用4個以上的連字符來標記水平分割線,記得上下有空行!

舉個栗子:

效果:

水平線
水平線

字體效果

斜體

以下二者都可

舉個栗子:

這是效果:

斜體
斜體

粗體字

以下兩者均可

舉個栗子:

效果:

粗體
粗體

 

如此的一些語法,應該已經足夠日常使用,更多的比如添加鏈接、插入圖片等等的高級使用這裡就不做介紹了,如果想要了解這些內容,請移步遊樂場標記格式註釋

 

本文由 落格博客 原創撰寫:落格博客 » 在 Playground 中使用 富文本註釋

轉載請保留出處和原文鏈接:https://www.logcg.com/archives/1058.html

通過 落格博客

如非聲明,本人所著文章均為原創手打,轉載請註明本頁面鏈接和我的名字。

發表評論

您的電子郵件地址不會被公開. 必填字段標 *