ドキュメントの機能と活用方法
Xcode には、英語ですがとても詳しいドキュメントが用意されています。API リファレンスから、プログラミングガイド、サンプルプロジェクトなども収録されていて、Xcode からだけでも多くのドキュメントを見つけられます。
ドキュメントを検索する
ドキュメントウィンドウに用意されている機能をひととおり紹介してきましたが、ドキュメントは何か分からないことが出てきたときに閲覧することが多いので、まずはドキュメントを探す方法から紹介します。
ドキュメント全体から目的のものを検索する
ドキュメント全体から目的のドキュメントを探すには、ツールバーのSearch
documentation
検索ボックスを使います。
![ドキュメントウィンドウの検索ボックス](image/22.2.1-01.make.png)
ここにキーワードを入力すると、それにつられて該当するドキュメントがリストに表示されて行きます。空白文字を挟むことで複数のキーワードを含むドキュメントに絞り込めます。
⇧
⌘
F
を押すことで、この検索ボックスに入力カーソルを移動できます。
ここにキーワードを入力して行って、リストのTop Hit
に目的のドキュメントが出てきたときにはreturnキーを押すことで、それを画面に表示できます。リスト内の他のドキュメントが見たいときには、カーソルキーで選択してreturnキーを押すか、マウスでその項目をクリックすることで見られます。
![ドキュメントウィンドウからの検索結果](image/22.2.1-02.png)
なお、ドキュメントは分類分けがされていて、このリストでも次のようなカテゴリで整理して表示されています。
カテゴリ | 内容 | |
---|---|---|
Top Hit |
入力したキーワードに最も適したドキュメントです。 | |
API Reference |
プログラミングのリファレンスです。クラスやメソッドなどの使い方が分からないときに利用します。 | |
![]() |
SDK Guides |
プログラミングに関して、ひとつのテーマについて詳しく説明されているガイドです。機能をどう実装したら良いか分からないときに利用します。 |
![]() |
Tool Guide |
プログラミングに関して、ひとつのテーマについて詳しく説明されているガイドです。機能をどう実装したら良いか分からないときに利用します。 |
![]() |
Sample Code |
Xcode で動かせるソースコードのサンプルです。機能の実装方法や動きを、具体例を見ながら使い方を学びたいときに便利です。 |
また、もう少し詳しく分類分けされていることもあります。
カテゴリ | 内容 | |
---|---|---|
![]() |
WWDC | Apple 社が開催している開発者カンファレンス WWDC のプレゼンテーション動画で見られるガイドです。wwdc core audioのように検索すると出てくることがあるので、WWDC で何か発表がなかったかを探したいときには便利かもしれません。 |
このほかにも、ソースコードに出てくるシンボル名にはXcode 5 徹底解説 for iOS/OS Xの2.3.3 シンボルナビゲーター
の中で紹介した記号が付けられています。
全ての検索結果を確認する
検索結果の数がある程度に絞られてくると、検索リストのいちばん下にShow All Results
という項目が表示されます。
![ドキュメントの検索結果からすべての候補を表示する](image/22.2.1-07.png)
これを選択することで、コンテンツ領域に、検索結果が整理されて表示されます。
![ドキュメントからの検索で見つかったすべての候補](image/22.2.1-08.make.png)
この画面の上側にあるタブには、キーワードで該当したドキュメントのカテゴリが表示され、切り替えられるようになっています。その下には、カテゴリ毎にドキュメントのタイトルがリストアップされます。それらをクリックすることで、そのドキュメントを表示できます。
キーワードを入力して出てきたリストでreturn
キーを押してドキュメントを表示した後に、もう一度return
キーを押しても、この画面が表示されます。リストから選んで開いてみたけれど、イメージと違ったのでもう少し詳しく探したいというようなときに便利です。
検索範囲を限定する
検索ボックスの左側にある「虫眼鏡」アイコンをクリックすると、キーワードで検索する範囲を限定できます。
![ドキュメントの検索範囲を限定する](image/22.2.1-09.png)
対象 | 範囲 |
---|---|
Automatic | 適したドキュメントを自動で選んで検索します。最前面で開いているワークスペースウィンドウが扱う SDK が対象になります。 |
All SDKs | iOS と OS X の両方のドキュメントを対象にします。 |
iOS | iOS のドキュメントだけを対象にします。 |
OS X | OS X のドキュメントだけを対象にします。 |
開いているドキュメント内を検索する
開いているドキュメントの中で検索したいときには、メニューバーの
Find
→
Find...
を選択します。
![開いているドキュメント内を検索する](image/22.2.2-01.png)
そうすると、ツールバーの直下に、ドキュメント内を対象にする検索ボックスが表示されます。
![ドキュメント内を検索するのに使う検索ボックス](image/22.2.2-02.make.png)
ここにキーワードを入力することで、その語句が登場する場所がハイライトで表示されます。ここでは、空白文字も普通の検索文字として扱われます。
![キーワードを入力すると、開いているドキュメント内の該当する語句がハイライト表示されます。](image/22.2.2-03.png)
検索で該当した箇所は、検索バーの右側にあるボタンで移動できます。
機能 | ショートカット | |
---|---|---|
![]() |
次の該当場所に移動します。検索ボックスでreturn キーを押したときと同じです。 |
⌘
G
|
![]() |
ひとつ手前の該当場所に移動します。検索ボックスでshift +return キーを押したときと同じです。 |
⇧
⌘
G
|
なお、右端にあるDone
ボタンをクリックすると、検索を終了して、検索ボックスを閉じられます。
検索オプションを変更する
検索ボックスの左側にある「虫眼鏡」アイコンをクリックすると、検索に関するオプションメニューが表示されます。
![検索オプションを指定してドキュメントを検索する](image/22.2.2-06.png)
ここのEdit Find Options...
を選択すると、検索オプションを選択できる画面になります。
![ドキュメントの検索で指定できる検索オプション](image/22.2.2-07.png)
項目 | 機能 |
---|---|
Match Case | 大文字小文字を区別して検索したいときにチェックを入れます。 |
Wrap | 該当部分を次へ次へと進めて行ったときに、末端で止まって欲しいときにチェックを外します。ここにチェックが入っていると、末端の次は最初の候補に移動します。 |
Xcode のメニューバーからドキュメントを素早く探す
Xcode の使い方について知りたい場合は、ドキュメントウィンドウを開かなくても、Xcode のメニューバーの
Help
にある検索ボックスから素早くドキュメントを検索できます。
![Xcode のメニューバーから素早く検索する](image/22.2.3-01.png)
ここのSearch
欄にキーワードを入力して行くと、それに該当する項目が表示されます。
カテゴリ | 内容 | |
---|---|---|
![]() |
Help Topics | Xcode などのツールの使い方に関するドキュメントです。 |
![]() |
Menu Items | そのキーワードに該当するメニュー項目です。 |
ここのHelp Topics
カテゴリに表示された項目を選択すると、ドキュメントウィンドウが開かれて、その内容が表示されます。
メニューを検索して実行する
面白いのがMenu Items
カテゴリで、キーワードに該当したメニュー項目の場所が表示され、しかもここから直接実行できます。
![検索ボックスからメニュー項目を探して実行する](image/22.2.3-04.make.png)
リストアップされた中からMenu Items
カテゴリの項目にマウスカーソルを乗せると、その項目が実際にあるメニューの場所が表示されます。そして、リストからその項目を選択すると、実際のメニューを選択したのと同じように、その機能が呼び出せます。
これを利用することで、たとえば実行したい機能があるけれど、それがメニューのどこにあるか分からなくなったというときに、その機能の使い方が書かれたドキュメントを探して読まなくても、ここでメニューの場所を探して即座に実行できます。
ドキュメントライブラリを閲覧する
ドキュメントにどのようなものがあるかを見ながら読み進めたい場合には、ナビゲーターのドキュメントライブラリを使用します。
![ドキュメントライブラリを閲覧する](image/22.2.4-01.make.png)
左側にナビゲーターを表示したら、その上側に表示されるタブでドキュメントライブラリのアイコンを選択します。そうすることで、Xcode にインストールされているドキュメントが一覧で表示されます。ここから、セクションを▶
ボタンで掘り下げて、気になるドキュメントをたどれます。
21 Xcode をカスタマイズするの中で紹介したDownloads 設定から行えます。