困った時に iOS 開発のドキュメントやサンプルコードを探す方法

iOS アプリの開発をしていて行き詰まると Google 検索することがよくある。というかほぼ毎日やっている。検索結果として Stack Overflow や Qiita, 個人のブログ記事を見つけて、困っていた問題が解決する場合がある。解決したい問題がフレームワークやライブラリの仕組み上必要なバッドノウハウだったりすればそれで構わない。しかし特定の API について体系だって書かれたドキュメントを読んで知識を得たい場合、正しい使い方を知りたい場合、知りたかった内容が必ずしも得られるとは限らない。その場合、適当にググって見つけた記事を読むよりも効果的な方法は以下の 2 つになるような気がしている。

  • 公式のドキュメントを確認する
  • 実際に動くコードを参考にする

公式ドキュメント Apple Developer

Apple Developer

基本的に公式の情報は全てここにある。ただ自分としては、初心者にはいまいち知りたい情報を探しにくいし取っつきづらいと感じている。

そこで Apple のエンジニア直伝の開発ドキュメント検索方法。昨年 WWDC のラボで

「 developer.apple.com って初心者にはいまいち知りたい情報を探しにくくないですか?例えばあなたはどうやってドキュメントを調べていますか?」

Apple のエンジニアに質問してみた。すると、そのエンジニアはそれは課題だと感じていて、 Google のサイト内検索機能を使っていると教えてもらった。

Google のサイト内検索

Google で検索したい内容を入力する時に、検索バーに site:https://developer.apple.com と入れることで、サイト内検索をすることができる。 例えば URLSession について調べたければこんなかんじ。

f:id:enmtknt:20190221182742p:plain

Xcode のドキュメント

同じように Xcode でドキュメントを調べることもできる。(Xcode 10.1)

Xcode を起動 -> Help -> Developer Documentation

f:id:enmtknt:20190221183629p:plain

実際に動くサンプルコード

実際に動くコードの例を探したいことは良くある。その場合に考えられるのが以下の方法。

  • GitHub でコードを検索する
  • Apple Developer のサンプルコードを読む

GitHub のコード検索

GitHub には世界中のエンジニアが書いたライブラリやフレームワークのコード、定番ライブラリを組み込んだアプリのコードがたくさん公開されている。これらは未経験の開発言語やフレームワーク、新しいライブラリを使う場合とても参考になる。検索ツールを使えば、言語や公開時期など細かい条件を指定してコードを検索することができる。

GitHub · Where software is built

f:id:enmtknt:20190222183023p:plain

Apple Developer のサンプルコード

Apple Developer にも動くプロジェクトとしてサンプルコードが公開されている。ぱっと見探しづらいが以下の方法で調べることができる。

Google サイト内検索を利用して検索

前述と同じ方法。

site:developer.apple.com Sample Code と入力する。

f:id:enmtknt:20190221183931p:plain

Documentation Archive の Sample Code

以下の Documentation Archive の Sample Code にも色々まとめられている。

Documentation Archive

f:id:enmtknt:20190221184214p:plain

所感

忙しいと Google 検索して済ませがちだけど、やはりオフィシャルのドキュメントにはフレームワークの正しい使い方が書いてあるし、実コードを手元で動かしたり、様々な使い方を目にすることで自分のコードに活かせる新しい発見がたくさんあるように思う。