コンテンツへスキップ

サイドバーのXcode Quick Help

Xcodeのサイドバーにあるクイックヘルプインスペクタは、カーソルの移動に合わせてドキュメントを自動更新し、Cmd+クリックでドキュメントを開く手間を省きます。

見落とされがちな機能

長年、Xcodeでドキュメントを確認する私のワークフローは同じでした:シンボルをCmd+クリックし、コンテキストメニューから「Show Quick Help」を選択し、ポップアップを読んで閉じ、コーディングを続ける。動作しますが、中断的です。各参照に3つのアクションが必要で、編集フローが途切れます。

その後、偶然にも右サイドバーのクイックヘルプインスペクタパネルを発見しました。

使い方

Option+Cmd+3でクイックヘルプインスペクタを開くか、View > Inspectors > Quick Helpから開きます。右サイドバーにパネルが開き、カーソルが現在置かれているシンボルのドキュメントが表示されます。コード内でカーソルを移動すると(メソッドをクリックしたり、パラメータ間を矢印キーで移動したり、型を選択したり)、サイドバーが自動的に更新されます。

クリックも不要で、閉じるポップアップもなく、中断もありません。コーディングを続けるだけで、関連するドキュメントが自動的に追従します。

Cmd+クリックより優れている理由

Cmd+クリックのアプローチには特有のコストがあります:「これのドキュメントが必要だ」と事前に判断する必要があります。サイドバーはこれを逆転させます。常に表示されているため、ドキュメントを受動的に吸収できます。意識的に調べる努力をしなくても、パラメータの説明、戻り値の型、非推奨の警告、利用可能性のアノテーションに気づくことができます。

これは、慣れていないAPIで作業する際に特に有用です。他のシンボルを次々とCmd+クリックする代わりに、カーソルをコード内で移動させながらサイドバーを読むだけです。ドキュメント参照が個別のアクションから連続的なストリームに変わります。

パネルにはクイックヘルプポップアップと同じ内容が表示されます:宣言、説明、パラメータ、戻り値、利用可能性、関連シンボル。唯一の違いは、表示と非表示を繰り返すのではなく、持続的にその場で更新されることです。

右サイドバーに十分なスクリーン幅がある場合、コーディング中にクイックヘルプを開いたままにしておくことは、時間とともに積み重なる小さなワークフロー改善の一つです。

参考になりましたか?BlueskyMastodonでフォローして、Swiftのヒントやインディー開発の最新情報をチェックしてください。