[Xcode]PlaygroundのコメントでMarkdownで書こう!

Swiftを手軽に実行できる環境を提供するPlaygroundですが、コメントをMarkdownでかけることはご存知でしたか?

今回の記事ではPlaygroundでMarkdownを書く方法をご紹介しようと思います。


環境

  • Swift2.2
  • Xcode7.3.1

Markdownを書く方法

PlaygroundのコメントでMarkdownを使うには、専用のコメントを書きます。

複数行では/*: 〜 */を、1つの行では//:を前につけます。

fig1

そしてXcodeのメニューからEditor > Show Raw Markupを選択します。

fig2

するとコメントがMarkdownで表示されます。

fig3


画像を表示する。

Playgroundでは、Resouresフォルダと呼ばれる画像を格納できるフォルダが予めあるので、そこに画像をいれると、Markdownで画像を表示することができます。

Xcodeメニューの右上のHide or Show The Navigatiorボタンをクリックしてナビゲーションを表示します。

fig4

ナビゲーションからResouresフォルダに画像を入れます。

fig5

Markdownで画像を表示します。

fig6

Editor > Show Raw Markupに切り替えると画像が表示されます。

fig7


注意点

レンダリングに時間がかかるのか、とっても重くなるので、一ページ100行以上は書かないほうが賢明です。


使いどころ

勉強会などで、コードを大勢でで共有する際に便利そうです。
コメントとコードが見た目で分かれるので、コードの説明には持って来いですね。

サードパーティのライブラリーでもサンプルコードをPlaygroundで記述しているプロジェクトが増えています。

リアクティグプログラミングフレームワークのRxSwiftやフォーム作成ライブラリーのEurekaなどです。

ぜひみなさんも使ってみてください。


参考

https://developer.apple.com/library/ios/documentation/Xcode/Reference/xcodemarkupformattingref/index.html#//appleref/doc/uid/TP40016497