GitHub 上のコード間を移動する

GitHub のナビゲーションコードについて

コードナビゲーションは、そのエンティティへの参照に対応する名前付きエンティティの定義と、エンティティの定義に対応する参照を表示しリンクすることで、コードの読み取り、ナビゲーション、理解に役立ちます。

関数が強調表示されたファイルを示すスクリーンショット。ポップアップには、[Definition] と [Reference] という 2 つのタブの関数に関する情報が表示されます。

コードナビゲーションでは、オープンソースの tree-sitter ライブラリを使用します。次の言語はコードナビゲーションをサポートしています。

コードナビゲーションを有効にするために、リポジトリで何かを構成する必要はありません。すべてのリポジトリで、これらのサポート対象言語のコードナビゲーション情報は自動的に抽出されます。

GitHub では、リポジトリ全体のすべての定義と参照を検索して、指定した名前のエンティティを見つけるという、オープンソースの tree-sitter ライブラリに基づいたコードナビゲーションアプローチを開発しました。

キーボードショートカットを使って、コードファイル内を移動できます。詳しくは、「キーボードショートカット」をご覧ください。

シンボルペインを使用して、コード内の関数やクラスなどのシンボルをすばやく表示したり移動したりできるようになりました。 1 つのファイル、リポジトリ内のすべてのファイル、さらには GitHub 上のすべてのパブリックリポジトリのシンボルを検索できます。

シンボル検索は、コード検索の機能です。詳しくは、「GitHub Code Search の構文について」をご覧ください。

リポジトリを選び、シンボルを含むファイルに移動します。
シンボルペインを表示するには、ファイルの内容の上にあるをクリックします。

または、ファイル内の対象シンボルをクリックしてシンボルペインを開くこともできます。クリック可能なシンボルは、マウスを合わせると黄色で強調表示されます。
シンボルペインまたはファイル自体から検索するシンボルをクリックします。
- リポジトリ全体でシンボルを検索するには、シンボルペインで [このリポジトリでこのシンボルを検索する] をクリックします。 GitHub のすべてのリポジトリでシンボルを検索するには、 [すべてのリポジトリ] をクリックします。
シンボルへの参照間を移動するには、またはをクリックします。
シンボルへの特定の参照に移動するには、[ In this file] の下にあるシンボル検索の結果をクリックします。
特定のシンボルの検索を終了するには、[ All Symbols] をクリックします。