Lesson 1.7 Documentation
p.71
困難なバグに悩まされている場合でも、新しいコードに精通している場合でも、開発を進める豊富なXcodeドキュメントにアクセスできます。
このレッスンでは、Appleの専門家が書いたサンプルコードのライブラリなど、複数の形式のドキュメントをダウンロードして表示する方法を学びます。
あなたが学ぶこと
・ドキュメントブラウザの使い方
・サンプルコードとフレームワークガイドの見つけ方
Vocabulary
・documentation browser
・Quick Help
・symbol
Related Resources
API Reference
Xcode Help: Search for developer documentation
p.72
すべての開発者は、ドキュメントにアクセスするための好ましい方法を持っています。ウェブブラウザで表示することを好む人もいれば、デスクトップにダウンロードしたい人もいます。ドキュメントを操作する複数の方法を学ぶことで、どの方法が最適かを決めることができます。質問に対する答えを見つけるのが早ければ早いほど、コードを書くのが早く戻ることができます。
ドキュメンテーションブラウザ
前のレッスンでは、viewDidLoad()関数内にコード行を追加しました。その関数が何をするのか、プログラムで関数がいつ呼び出されるか知っていますか?
Xcodeは、クイックヘルプ機能を使用して迅速な回答を提供します。
Optionキーを押しながらviewDidLoad()メソッド名をクリックすると、Xcodeは機能とそれをサポートするOSバージョンの簡単な説明を含むポップオーバーを表示します。
また、関数がどのフレームワークに属しているかも示します。この場合、フレームワークはUIKitです。
p.73
クイックヘルプポップオーバーで、[Method Reference]をクリックして、より詳細な説明と関連機能への参照を含むXcodeドキュメントにアクセスします。
(このウィンドウには、Xcodeヘルプメニューから、またはショートカットCommand-Shift-0を使用してアクセスすることもできます。)
ドキュメントの右側にあるリンクを使用すると、同じページ上のさまざまな情報にすばやくジャンプできます。
p.74
ドキュメントウィンドウの上部には、任意の関数、クラス、またはフレームワークに関するドキュメントを検索できる検索フィールドが表示されます。この機能により、何千ページものドキュメントをすばやく検索できるため、回答はすぐに入手できます。そのため、多くの開発者はコーディング中にドキュメントウィンドウを開いたままにしておくことを選択します。
Xcodeのドキュメントをナビゲートしてみてください。UIViewControllerの入力を開始すると、Xcodeを入力すると、自動補完で一致するオプションが提案されます。メニュー(APIリファレンスセクション)にUIViewControllerが表示されたらすぐに、それを選択してUIViewControllerのドキュメントを表示します。
右上隅の[このページ]の下にある[トピック]リンクをクリックして、ページをジャンプします。
「トピック」セクションには、トピックごとにグループ化されたシンボルのリストが表示されます。シンボルは、特定のクラスに関連付けられた関数または変数です。ドキュメントでは、これらのシンボルはアルファベット順ではなく論理カテゴリに分類されているため、興味のあるアイテムをより簡単に見つけることができます。
p.75
新機能を構築するとき、これらの論理カテゴリは、オブジェクトが構築しようとしていることをできるかどうかを調べるのに最適な方法を提供します。
UIViewControllerのトピックを見て、viewプロパティのシンボルを探してみてください。このsymbolをクリックしてください。
p.76
ここでは、選択したプロパティの情報が表示されます。ほとんどのインスタンスプロパティドキュメントは、同様のパターンに従います。
・簡単な説明 - プロパティが何であるかの簡単な要約
・宣言 — プロパティへのアクセスに使用される名前とプロパティの関連タイプ
・ディスカッション — プロパティを使用する際に考慮すべきより細かい(重要とはいえ)要素について議論する詳細な説明
参照 —興味のある物件に関連するその他の記号
左上隅には、シェブロンの付いたボタンが2つあります〈 〉
あなたの閲覧履歴を通して、これらを使用して後方にナビゲーションする
戻るボタンをクリックして、UIViewControllerのドキュメントに戻ります。function viewWillAppear(_:) のシンボルを見つけます。
p.77
ほとんどのメソッドドキュメントは、インスタンスプロパティドキュメントと非常によく似たパターンに従います。
パラメータ — 関数にパラメータ(入力)がある場合、パラメータにアクセスするために使用される名前とパラメータの簡単な説明がリストされます。
このコースでは、ドキュメントブラウザでさらに作業します。
サンプルコードとガイド
技術文書は、一部のプログラマーや特定の状況にとって必ずしも最高の学習リソースであるとは限りません。
コーディングの概念を進めるにつれて、それらを実際に見ると便利です。
Appleは、フレームワークとその機能の使い方をすばやく理解するのに役立つ多数のガイドとサンプルコードプロジェクトを提供しています。
Apple DeveloperのWebサイトにアクセスして、これらのガイドとサンプルコードプロジェクトを表示またはダウンロードできます。
開発者を成功させるには、ドキュメントの読み方と理解方法を学ぶ必要があります。
ドキュメンテーションは非常に技術的であるため、初めて読むときに消化するのは難しい場合があります。練習が必要です。
このコースでは、「関連リソース」セクションのリファレンスガイドとAPIドキュメントへのリンクが表示されます。それらを読んでください。読書からすべての文章や概念を常に理解しているとは限りませんが、開発者を成功させるのに役立つ非常に有用なスキルを構築します。
p.78
このラボの目的は、Xcodeのドキュメントを使用してiOSフレームワークについて学ぶことです。
ドキュメントとクイックヘルプをナビゲートして、UIViewクラスとXcodeプロジェクトで提供されるメソッドに関する質問に答えます。
ステップ1:回答用のPagesドキュメントを作成する
「Lab - Use Documentation」という新しいPagesドキュメントを作成し、プロジェクトフォルダに保存します。このドキュメントを使用して、このラボの残りの部分の質問に対する回答を書き留めてください。
ステップ2:ドキュメントを使用してUIViewクラスについて学ぶ
・UIViewオブジェクトの主な3つの責任は何ですか?
・ドキュメントは、別のビューに埋め込まれたビューを何と呼びますか?
・ドキュメントは、他のビューを埋め込んでいる親ビューを何と呼びますか?
・ビューのフレームとは何ですか?
・ビューの境界はフレームとどう違うのですか?
Pages 書類は必ずプロジェクトフォルダに保存してください。