Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Swift ドキュメントコメント

4,105 views

Published on

2015-11-05 に開催された『iOS 9 週連続 Bootcamp!』の第6回目で Xcode 7 の新機能について紹介 (http://www.slideshare.net/tomohirokumagai54/xcode-7-cmios9) してきた中で、時間の都合でカットしたドキュメントコメントの内容です。

Published in: Software
  • Follow the link, new dating source: ♥♥♥ http://bit.ly/2Qu6Caa ♥♥♥
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here
  • Dating for everyone is here: ❤❤❤ http://bit.ly/2Qu6Caa ❤❤❤
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here
  • Download or read that Ebooks here ... ......................................................................................................................... DOWNLOAD FULL PDF EBOOK here { http://bit.ly/2m77EgH } ......................................................................................................................... Download EPUB Ebook here { http://bit.ly/2m77EgH } ......................................................................................................................... Download Doc Ebook here { http://bit.ly/2m77EgH } ......................................................................................................................... .........................................................................................................................
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here

Swift ドキュメントコメント

  1. 1. EZ-NET 熊⾕友宏 http://ez-net.jp/ 2015.11.02 ドキュメントコメント Xcode 7 & Swift 2
  2. 2. 熊谷友宏 EZ-NET http://ez-net.jp/ @es_kumagai CodePiece iOS, OS X, Apple Watch アプリ ソースコードを Twitter と Gist に同時投稿できる。 いつもの電卓 計算式も見える電卓アプリ。 watchOS 1 対応 音で再配達ゴッド 簡単操作で 再配達の申し込み。 EZ-NET IP Phone iPhone でひかり電話を使う。 自宅 LAN からの利用専用
  3. 3. 熊谷友宏 EZ-NET http://ez-net.jp/ @es_kumagai 横浜 iPhone 開発者勉強会 #yidev 勉強会 わいわい・ゆるく、iPhone 開発者の
 みんなで楽しく過ごすのが目的の会 【 横浜・馬車道 】 カジュアル Swift 勉強会 #cswift ゆるくみんなで Swift を語らえる場を
 作りたくて始めた会 【 横浜・青葉台 】 第21回を 2015-12-12 に開催 第3回を 2015-11-14 に開催
  4. 4. 熊谷友宏 EZ-NET http://ez-net.jp/ @es_kumagai Xcode 5 徹底解説 MOSA 書籍 / 登壇 Xcode 5 の全機能を
 徹底的に解説した本 OSX/iOS 系の歴史深い
 有料会員制の勉強会 紙版は絶版、電子書籍は販売中 秀和システム 10x-Eng.com で取扱予定 2015-11-07 の MSM2015 で Swift 2 を始めたい人向けの話で登壇 Xcode 7 でも役立つはず 法人会員も多数
  5. 5. Xcode 5 徹底解説 著書 > 全機能を徹底解説 ✔ 各画面の使い方 ✔ プロジェクトやコードの編集 ✔ インターフェイスビルダー ✔ ビルドとデバッグ ✔ ユニットテストと Bot > 紙版は絶版 (2015/08/21) > 電子書籍版は販売中 ✔ 10x-Eng.com でも取扱予定 2014/04/28 - 2015/08/21 750 ページ
  6. 6. Swift 2 の話をする予定 MSM 2015 > MSM 2015 ✔ NPO 法人 MOSA 主催 ✔ 有料イベント(会員制) ✔ 年に一度の2日間に渡る
 お祭り的なイベント ✔ Apple 最新技術の話題満載 > NPO 法人 MOSA ✔ 10 年以上の活動実績 ✔ 法人会員での参加も多い印象 2015/11/06 - 2015/11/07 http://www.mosa.gr.jp/
  7. 7. Xcode 7 ̶ 2015.09.16 ̶
  8. 8. ▶ Swift 2 ▶ 新 OS サポート ▶ UI テスト ▶ コードカバレッジ ▶ ドキュメントコメント ▶ 呼出階層検索ナビゲーター ▶ インターフェイス定義の確認 ▶ 無料のオンデバイス開発 新機能 Xcode 7 ▶ コンテナービュー ▶ スタックビュー ▶ ストーリーボード参照 ▶ オンデマンドリソース
  9. 9. ドキュメントコメント
  10. 10. ▶ 型や機能に説明を記載できる ▶ コード補完時に概要を見られる ▶ クイックヘルプで詳細を見られる 機能 ドキュメントコメント
  11. 11. ▶ Markdown のような書式 • テキストの装飾 • 画像の挿入 • リンクの挿入 ▶ プレイグラウンド専用機能 • ページナビゲーション • リッチコメント描画 ▶ Swift 専用 機能 強化されたドキュメントコメント
  12. 12. 1. シンボルの文書化 ▶ 型や機能にドキュメントを添える ▶ クイックヘルプやコード補完で見れる ▶ ソースコードとプレイグラウンドで使える 2. リッチコメント ▶ 見栄えの良いコメントが書ける ▶ プレイグラウンドをドキュメントとして見せる ▶ プレイグラウンド専用 利用できる場面 強化されたドキュメントコメント
  13. 13. 1. シンボルの文書化
  14. 14. ▶ 型や機能にドキュメントを添える ▶ 専用の書式で意味付けできる ▶ ソースコードとプレイグラウンドの
 両方で使用できる ▶ クイックヘルプやコード補完で見れる 特徴 シンボルの文書化
  15. 15. ▶ コメント行内でマークアップする ▶ コメント行は次の2通りで書く (a) /// でコメント行を書く(複数行可) (b) /** ∼ */ でコメントブロックを書く 書き方 シンボルの文書化
  16. 16. 記載 シンボルの文書化 /// 指定したターゲットをビルドします。 /// 設定を追加することで異なるオプションでビルドできます。 /// /// - precondition: /// ビルド対象のプロジェクトが開かれている必要があります。 /// /// - parameters: /// - target: ビルドするターゲットです。 /// - configuration: ビルドで使う設定です。 /// /// - returns: ビルドの実行結果を返します。 /// - throws: エラー時は BuildError が投げられます。 func build(target:Target, config:Config) throws -> Report {
  17. 17. ▶ コード補完 表示 シンボルの文書化 ▶ クイックヘルプ
  18. 18. 2. リッチコメント
  19. 19. ▶ プレイグラウンドだけで使える ▶ 見栄えの良いコメントが書ける ▶ プレイグラウンドファイルを
 まるごとドキュメントとして見せる 特徴 リッチコメント
  20. 20. ▶ コメント行内でマークアップする ▶ コメント行は次の2通りで書く (A) //: でコメント行を書く(複数行可) (B) /*: ∼ */ でコメントブロックを書く 書き方 リッチコメント
  21. 21. 記載 リッチコメント //: ## `reduce` メソッド //: 配列の **総和** を簡単に計算できます。 //: ### 準備 let values = [1, 3, 8, 20] //: ### 実行 let sum = values.reduce(0, combine: +)
  22. 22. 表示 リッチコメント
  23. 23. ▶ ファイルインスペクターで切り替える 表示の切り替え リッチコメント オン・オフで 切り替わる
  24. 24. ▶ リッチコメント表示中でも • 実行コードを編集できる ▶ リッチコメント表示中は • リッチコメントを編集できない • 通常のコメントは編集できる 留意点 リッチコメント
  25. 25. マークアップ
  26. 26. ▶ シンボルの文書化やリッチコメントの
 内容に付加情報を添える ▶ コマンドを使ってマークアップする ▶ コマンドはインデントレベルが大事 • インデントによって解釈が変わる • コメントブロックの最初が第一レベル ▶ Markdown みたいな書式 基本 マークアップ
  27. 27. 1. 行書式コマンド 2. テキスト書式コマンド 3. シンボル文書化コマンド 4. ページナビゲーションコマンド コマンドの種類 マークアップ リッチコメント 専用 シンボル文書化 専用
  28. 28. 1. 行書式コマンド シンボル文書化 リッチコメント
  29. 29. ▶ 行単位で書式を指定する 特徴 行書式コマンド 基本書式 行書式コマンド 行テキスト シンボル文書化 リッチコメント 空白必須
  30. 30. ▶ 見出し ▶ ブロック引用 ▶ 箇条書き ▶ 番号付き箇条書き ▶ コードブロック ▶ 水平線 ▶ リンク参照 種類 行書式コマンド
  31. 31. 行書式コマンド 見出し シンボル文書化 リッチコメント
  32. 32. ▶ 行を見出しとして扱う ▶ 先頭の # の数でレベルを指定(3レベルまで) 見出し 行書式コマンド 記載方法 最初の見出しです。 シンボル文書化 リッチコメント 次の見出しです。 # ## 記号の数で
 レベル指定 空白必須
  33. 33. 見出し 行書式コマンド //: 見出しを表示します。 //: # 最初の見出しです。 //: ## 次の見出しです。 //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  34. 34. ▶ 見出しを次行の下線で表現する • レベル1は === で表現する • レベル2は --- で表現する 見出し(別の書き方) 行書式コマンド 記載方法 シンボル文書化 リッチコメント 見出しです。 ====== ↩ 最初は空行 2行目で
 下線を表現 リッチコメント
  35. 35. 見出し 行書式コマンド //: 見出しを表示します。 //: //: 見出しです。 //: =========== //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  36. 36. 行書式コマンド ブロック引用 シンボル文書化 リッチコメント
  37. 37. ▶ 内容を引用として扱う ▶ 連続で書くと1つとして扱われる ブロック引用 行書式コマンド 記載方法 > 引用してきたテキストを記載します。 シンボル文書化 リッチコメント > 複数行に分けて続きを記載できます。 空白必須↩ 最後は空行
  38. 38. ブロック引用 行書式コマンド //: 次のような説明が記載されています。 //: //: > 引用してきたテキストを記載します。 //: > 複数行に分けて続きを記載できます。 //: //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  39. 39. 行書式コマンド 箇条書き シンボル文書化 リッチコメント
  40. 40. ▶ 先頭は *, +, - のどれかで える ▶ 同レベルの項目は同じインデントで書く 箇条書き 行書式コマンド 記載方法 * 最初の項目 シンボル文書化 リッチコメント * ふたつ目の項目 ↩ 最後は空行 空白必須 インデント を える ふたつ目にぶら下げた項目* レベルを
 変えられる
  41. 41. 箇条書き 行書式コマンド //: 項目を箇条書きします。 //: * 最初の項目 //: * ふたつ目の項目 //: * ふたつ目にぶら下げた項目 //: //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  42. 42. 行書式コマンド 番号付き箇条書き シンボル文書化 リッチコメント
  43. 43. ▶ 先頭を 番号 と .で始める ▶ どんな番号でも連番に振り直される 番号付き箇条書き 行書式コマンド 記載方法 . 最初の項目 シンボル文書化 リッチコメント . ふたつ目の項目 ↩ 最後は空行 インデント を える ぶら下げた項目. レベルを
 変えられる 1 1 1
  44. 44. 番号付き箇条書き 行書式コマンド //: 項目を箇条書きします。 //: 1. 最初の項目 //: 1. ふたつ目の項目 //: 1. ふたつ目にぶら下げた項目 //: //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  45. 45. 番号付き箇条書き 行書式コマンド //: 3. 最初の項目 //: 3. ふたつ目の項目 シンボル文書化は1番から リッチコメント 採番のされ方が異なる シンボル文書化 リッチコメントは指定番号から 表示例
  46. 46. 行書式コマンド コードブロック シンボル文書化 リッチコメント
  47. 47. ▶ 内容をプログラムコードとして扱う ▶ インデントして内容を記載する コードブロック 行書式コマンド 記載方法 let 数値列 = [1, 3, 5, 7] シンボル文書化 リッチコメント let 総和 = 数値列.reduce(0, combine: +) ↩ 最後は空行 ↩ 最初は空行 インデント 必須
  48. 48. ``` ▶ 上下を ``` で括って書ける ▶ シンボル文書化だけで使える コードブロック(別の書き方) 行書式コマンド 記載方法 シンボル文書化 リッチコメント 空行不要 let 数値列 = [1, 3, 5, 7] let 総和 = 数値列.reduce(0, combine: +) ``` インデント
 不要
  49. 49. コードブロック 行書式コマンド //: サンプルコードです。 //: //: let 数値列 = [1, 3, 5, 7] //: let 総和 = 数値列.reduce(0, combine: +) //: //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  50. 50. 行書式コマンド 水平線 シンボル文書化 リッチコメント
  51. 51. ▶ 行を水平線にする ▶ 3文字以上のハイフンで表現する 水平線 行書式コマンド 記載方法 シンボル文書化 リッチコメント ↩ 最後は空行 ↩ 最初は空行 −−− 3文字以上
  52. 52. 水平線 行書式コマンド //: 水平線で分断します。 //: //: - - - //: //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  53. 53. 行書式コマンド リンク参照 シンボル文書化 リッチコメント
  54. 54. ▶ リンク付きテキストを定義する ▶ 定義後に本文内でテキストを使う リンク参照 行書式コマンド 記載方法 [ テキスト シンボル文書化 リッチコメント 定義したテキスト ↩ 必要に
 応じて最初は改行 ] URL " "ホバーテキスト [ テキスト ] を使う
  55. 55. リンク参照 行書式コマンド //: テキストにリンクを定義して使います。 //: //: [EZ-NET]: http://ez-net.jp "EZ-NET" //: 定義したテキスト [EZ-NET] を使います。 //: 以上 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  56. 56. 2. テキスト書式コマンド シンボル文書化 リッチコメント
  57. 57. ▶ 文字列単位で書式を指定する 特徴 テキスト書式コマンド 基本書式 コマンド テキスト シンボル文書化 リッチコメント コマンドテキスト テキスト
  58. 58. ▶ 強調表記 ▶ コード表記 ▶ 画像表記 ▶ リンク参照 ▶ 記号のエスケープ 種類 テキスト書式コマンド
  59. 59. テキスト書式コマンド 強調表記 シンボル文書化 リッチコメント
  60. 60. ▶ テキストを強調して表示する ▶ 両側を * または _ で括る 強調表記 : 斜体 テキスト書式コマンド 記載方法 * 二種類の変数 シンボル文書化 リッチコメント *Swift には があります。 目的の語句 を囲う
  61. 61. 強調表記 : 斜体 テキスト書式コマンド //: テキストの一部を強調して表現します。 //: //: Swift には *二種類の変数* があります。 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  62. 62. ▶ テキストを強調して表示する ▶ 両側を ** または __ で括る 強調表記 : 太字 テキスト書式コマンド 記載方法 ** 構造体 シンボル文書化 リッチコメント **Swift はデータを で表現します。
  63. 63. 強調表記 : 太字 テキスト書式コマンド //: テキストの一部を強調して表現します。 //: //: Swift ではデータを **構造体** で表現します。 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  64. 64. ▶ テキストを強調して表示する ▶ 両側を *** または ___ で括る 強調表記 : 太字と斜体 テキスト書式コマンド 記載方法 *** 変数で振る舞いが変化 シンボル文書化 リッチコメント ***構造体は します。
  65. 65. 強調表記 : 太字と斜体 テキスト書式コマンド //: テキストの一部を強調して表現します。 //: //: 構造体は ***変数で振る舞いが変化*** します。 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  66. 66. テキスト書式コマンド コード表記 シンボル文書化 リッチコメント
  67. 67. ▶ テキストがコードであることを表現する ▶ 両側を ` で括る コード表記 テキスト書式コマンド 記載方法 ` let シンボル文書化 リッチコメント `Swift では原則 で変数を扱います。
  68. 68. コード表記 テキスト書式コマンド //: テキストの一部をコードとして表現します。 //: //: Swift では原則 `let` で変数を扱います。 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  69. 69. テキスト書式コマンド 画像表記 シンボル文書化 リッチコメント
  70. 70. ▶ テキストに画像を挿入する ▶ 場面によって表現が変わる様子 • リッチコメントでは ブロック要素 • シンボル文書化では インライン要素 画像表記 テキスト書式コマンド 構文 [ ポップアップ シンボル文書化 リッチコメント ]! 交代テキスト ( 画像パス " " 必要に
 応じて )
  71. 71. 画像表記 テキスト書式コマンド //: コメント内に画像を挿入します。 //: //: ![Note](https://ez-net.jp/note.png) Swift は //: 目まぐるしく進化します。 表示例 リッチコメント 記載例 シンボル文書化 シンボル文書化はインライン リッチコメントはブロック扱い
  72. 72. ▶ HTML タグで画像を挿入する ▶ シンボルの文書化だけで使える様子 ▶ 正式な方法かは不明 画像サイズを変えたい時 テキスト書式コマンド シンボル文書化 リッチコメント
  73. 73. テキスト書式コマンド /// コメント内に画像を挿入します。 /// /// <img src="https://ez-net.jp/note.png" style="width: 14px /> Swift は /// 目まぐるしく進化します。 記載例 シンボル文書化 画像サイズを変えたい時 表示例(シンボル文書化) リッチコメント
  74. 74. 画像のカレントパス テキスト書式コマンド リッチコメント シンボルの文書化 シンボル文書化 リッチコメント
  75. 75. テキスト書式コマンド リンク参照 シンボル文書化 リッチコメント
  76. 76. テキスト ▶ URL リンク付きのテキストを表現する ▶ テキスト内で自由に使える リンク参照 テキスト書式コマンド 記載方法 [ テキスト シンボル文書化 リッチコメント ] URL( ) テキスト
  77. 77. リンク参照 テキスト書式コマンド //: テキスト書式コマンドなら //: 事前定義なく [リンク](http://ez-net.jp) を使えます。 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  78. 78. テキスト書式コマンド 記号のエスケープ シンボル文書化 リッチコメント
  79. 79. テキスト ▶ 特別な記号をそのまま表示できる 記号のエスケープ テキスト書式コマンド 記載方法 記号 シンボル文書化 リッチコメント テキスト
  80. 80. 記号のエスケープ テキスト書式コマンド //: 次のように書くとリンクを挿入できます。 //: //: [タイトル](https://ez-net.jp) 表示例(リッチコメント) リッチコメント 記載例 シンボル文書化
  81. 81. 3. シンボル文書化コマンド シンボル文書化 リッチコメント
  82. 82. ▶ シンボルの説明に意味を添える ▶ 4つのセクションで構成される ▶ ハイフン記号で書き始める 特徴 シンボル文書化コマンド 書式 - コマンド シンボル文書化 リッチコメント : コンテンツ コンテンツの続きを次行に記載できる ↩ 最後は改行か
 別のコマンド 必要に
 応じて
  83. 83. 1. Description セクション 2. Parameters セクション 3. Returns セクション 4. Throws セクション 4つのセクション シンボル文書化コマンド シンボル文書化 リッチコメント
  84. 84. セクション Description シンボル文書化 リッチコメント
  85. 85. コンテンツ ▶ シンボルの説明を扱う ▶ コマンドを明記しないテキストが所属する ▶ 複数の Description フィールドを持てる Description セクション シンボル文書化コマンド 基本書式 シンボル文書化 リッチコメント コマンドを含めず
 テキストを記載
  86. 86. Description セクション シンボル文書化コマンド /// 現在のターゲットを取得します。 var currentTarget:Target 表示例 記載例 シンボル文書化 リッチコメント
  87. 87. ▶ Description セクションに情報を添える ▶ いくつでも追加できる Description フィールド シンボル文書化コマンド 基本書式 シンボル文書化 リッチコメント - フィールド名 : 説明文 説明文の続きを次行に記載できる ↩ 最後は改行か
 次のコマンド 必要に
 応じて
  88. 88. Description フィールド シンボル文書化コマンド /// ストリームの末端まで読み進められているか調べます。 /// - precondition: ストリームが開かれている必要があります。 /// - note: 文字列ストリームでは NUL を末端とみなします。 func isEOF(stream:Stream) -> String { 表示例 記載例 シンボル文書化 リッチコメント
  89. 89. Description で使えるフィールド名 (1/4) シンボル文書化コマンド シンボル文書化 リッチコメント - : 注目して欲しい情報を記載attention - : 著作者名author - : バグに関する情報を記載bug - : アルゴリズム的な複雑さを記載Complexity - : 著作権に関する情報を記載copyright - : 何らかの日付情報を記載date - : 試験的な機能であることを記載experiment
  90. 90. Description で使えるフィールド名 (2/4) シンボル文書化コマンド シンボル文書化 リッチコメント - : 使用上の重要情報を記載important - : 実行中に変化しないものを明記invariant - : 補足情報を記載note - : 実行に必要な値の前提条件を記載precondition - : 実行直後の値の変化を記載postcondition - : シンボルの解説を記載remark
  91. 91. - : 実行に必要な環境情報を記載requires Description で使えるフィールド名 (3/4) シンボル文書化コマンド シンボル文書化 リッチコメント - : 別の参考資料を記載seealso - : いつから使えるようになったかを記載since - : 実行完了に必要な追加タスクを記載todo - : シンボルのバージョン情報を記載version - : 使用上の注意事項を記載warning
  92. 92. - :authors Description で使えるフィールド名 (4/4) シンボル文書化コマンド シンボル文書化 リッチコメント 基本書式 ↩ ▶ 複数人数の著作者情報を記載 著作者名 著作者名 ↩ 最後は改行 改行で 次の人
  93. 93. セクション Parameters シンボル文書化 リッチコメント
  94. 94. ▶ シンボルの引数を扱う ▶ 複数のフィールドを持てる Parameters セクション シンボル文書化コマンド 基本書式 シンボル文書化 リッチコメント - 引数名 : 説明文 説明文の続きを次行に記載できる ↩ 最後は改行か
 次のコマンド 必要に
 応じて parameter
  95. 95. Parameters セクション シンボル文書化コマンド /// ストリームに値を書き込みます。 /// - parameter value: 書き込む値です。 /// - parameter stream: 書き込み先のストリームです。 func write(value:String, stream:Stream) { 表示例 記載例 シンボル文書化 リッチコメント
  96. 96. - :parameters Parameters の一括定義 シンボル文書化コマンド シンボル文書化 リッチコメント 基本書式 ▶ 複数の引数情報を記載 ↩ 説明文- :引数名 説明文- :引数名 インデント 必須 最後は改行か
 次のコマンド
  97. 97. Parameters の一括定義 シンボル文書化コマンド /// ストリームに値を書き込みます。 /// - parameters: /// - value: 書き込む値です。 /// - stream: 書き込み先のストリームです。 func write(value:String, stream:Stream) { 表示例 記載例 シンボル文書化 リッチコメント
  98. 98. セクション Returns シンボル文書化 リッチコメント
  99. 99. ▶ シンボルの戻り値を扱う ▶ ひとつだけ指定できる Returns セクション シンボル文書化コマンド 基本書式 シンボル文書化 リッチコメント - 説明文 説明文の続きを次行に記載できる ↩ 最後は改行か
 次のコマンド 必要に
 応じて returns :
  100. 100. Returns セクション シンボル文書化コマンド /// ストリームから値を読み込みます。 /// - returns: 読み取った文字列を返します。 func read(stream:Stream) -> String { 表示例 記載例 シンボル文書化 リッチコメント
  101. 101. セクション Throws シンボル文書化 リッチコメント
  102. 102. ▶ エラーに関する情報を扱う ▶ ひとつだけ指定できる Throws セクション シンボル文書化コマンド 基本書式 シンボル文書化 リッチコメント - 説明文 説明文の続きを次行に記載できる ↩ 最後は改行か
 次のコマンド 必要に
 応じて throws :
  103. 103. Throws セクション シンボル文書化コマンド /// ストリームに値を書き込みます。 /// - throws: ストリームが開かれてないと /// Stream.NotOpenError が発生ます。 func write(value:String, stream:Stream) throws { 表示例 記載例 シンボル文書化 リッチコメント
  104. 104. シンボル文書化 4. ページナビゲーションコマンド リッチコメント
  105. 105. ▶ ページ移動するための機能 • 指定ページに移動する • 前後のページに移動する ▶ リッチコメントだけで使える 特徴 ページナビゲーションコマンド シンボル文書化 リッチコメント
  106. 106. [ 表題 ] 移動先ページ名( ) ▶ 指定したページ名へのリンクを作れる ▶ ページ名の空白文字は %20 に置き換える 指定ページに移動 ページナビゲーションコマンド 記載方法 シンボル文書化 リッチコメント
  107. 107. [ 表題 ] @next( ) ▶ 次のページへのリンクを作れる ▶ 順番はプロジェクトナビゲーターで指定する 次のページに移動 ページナビゲーションコマンド 記載方法 シンボル文書化 リッチコメント
  108. 108. [ 表題 ] @previous( ) ▶ 前のページへのリンクを作れる ▶ 順番はプロジェクトナビゲーターで指定する 前のページに移動 ページナビゲーションコマンド 記載方法 シンボル文書化 リッチコメント
  109. 109. ページ シンボル文書化 リッチコメント
  110. 110. ▶ プレイグラウンド内に
 複数のページを追加できる機能 ▶ プロジェクトナビゲーターで管理する Playground ページ ページナビゲーションコマンド シンボル文書化 リッチコメント
  111. 111. ▶ 各ページがリソースを持てる ▶ Playground ファイル直下のリソースは
 すべてのページで利用できる様子 Playground ページのリソース ページナビゲーションコマンド シンボル文書化 リッチコメント このページ
 専用 全ページで 使える
  112. 112. ページ作成 シンボル文書化 リッチコメント
  113. 113. ▶ プロジェクトナビゲーターから作成 ページの新規作成 Playground ページ シンボル文書化 リッチコメント 新規作成 ⌥ + Click
  114. 114. ▶ プロジェクトナビゲーターで
 登録されている順番で管理される ページの順番 Playground ページ シンボル文書化 リッチコメント ページは この順番
  115. 115. ページ移動 シンボル文書化 リッチコメント
  116. 116. 指定ページに移動 ページ移動 //: 目次 //: //: [セクション A](Section%20A) //: //: [セクション B](Section%20B) 表示例 記載例 シンボル文書化 リッチコメント
  117. 117. 指定ページに移動 ページ移動 //: [前のページ](@previous) //: //: [次のページ](@next) 表示例 記載例 シンボル文書化 リッチコメント
  118. 118. まとめ
  119. 119. ▶ シンボルに説明を記載できる • セクションで詳しく意味づけできる • コード補完やクイックヘルプで見れる • テキストを装飾できる ▶ Playground コメントの可能性が広がる • テキストを装飾できる • ページ移動のリンクが貼れる まとめ ドキュメントコメント
  120. 120. ▶ コメントの書き方 ▶ 強化されたドキュメントコメント ▶ シンボルの文書化 ▶ リッチコメント ▶ マークアップ ▶ 行書式コマンド ▶ テキスト書式コマンド ▶ シンボル文書化コマンド ▶ ページナビゲーションコマンド ドキュメントコメント Xcode 7 + Swift 2
  121. 121. おまけ ドキュメントコメント
  122. 122. もしかして HTML タグが使える?
  123. 123. HTML タグを混ぜられる? ドキュメントコメント 説明の中で HTML を使うと
  124. 124. ドキュメントコメント クイックヘルプ に反映される HTML タグを混ぜられる?
  125. 125. スタイルシートも混ぜられる? ドキュメントコメント スタイルを 説明に添えると
  126. 126. ドキュメントコメント クイックヘルプ に反映される スタイルシートも混ぜられる?
  127. 127. スタイル指定はお勧めできない? ドキュメントコメント ▶ コメント毎にスタイルが必要 ▶ コメントの度に本格的なスタイルを
 記載するのは非現実的 ▶ 見た目の統一性がなくなる ▶ そもそも正式に使える機能か判らない
  128. 128. もしかして JavaScript が使える?
  129. 129. JavaScript を混ぜられる? ドキュメントコメント クイックヘルプ で実行される 説明の中で script を使うと
  130. 130. JavaScript を混ぜられる? ドキュメントコメント コード補完だと
 バレバレ ▶ ただしコード補完では
 スクリプトがそのまま表示される
  131. 131. JavaScript 埋め込みはお勧めできない? ドキュメントコメント ▶ 正式に使える機能か判らない ▶ コード補完でコードがそのまま表示される ▶ そもそもそこまで必要なのか?
  132. 132. おすすめ ドキュメントコメント
  133. 133. 絵文字を活用する ドキュメントコメント 説明の中で 絵文字を使うと
  134. 134. 絵文字を活用する ドキュメントコメント コード補完で 表示される
  135. 135. 絵文字を活用する ドキュメントコメント クイックヘルプで 表示される
  136. 136. 絵文字で検索できる! ドキュメントコメント 検索できる! 絵文字を
 使って …
  137. 137. おしまい☺

×