Playground でコードの他に専用ドキュメントを Markdown で書けることを今更知ったのでメモ。

概要

Markup Format for Playground Comments

Use markup formatting commands to create rich comments in playgrounds and to document your Swift symbols for Xcode quick help. https://developer.apple.com/library/ios/documentation/Xcode/Reference/xcode_markup_formatting_ref/

記述

//: 単行ドキュメント

/*:
複数行ドキュメント
*/

/*:

# 見出し
## 見出し
### 見出し
#### 見出し
##### 見出し
###### 見出し

[リンク](http://xxxxxxx.xxx/xxxxxx)

![画像](http://xxxxxxx.xxx/xxxxxx.png)
![ローカルの画像](xxxxxx.png)

*イタリックテキスト*
**ボールドテキスト**

*/

表示

レンダリング表示(編集不可)

[Editor]メニュー → [Show Rendered Markup]、または [File Inspector] の [Render Documentaion] のチェックを入れる。

Markdown 表示(編集可)

[Editor]メニュー → [Show Raw Markup]、または [File Inspector] の [Render Documentaion] のチェックを外す。

Next PostPrevious Post