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

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

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

コードナビゲーションの表示

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

言語	検索ベースのコードナビゲーション	正確なコードナビゲーション
C#	✅
CodeQL	✅
Elixir	✅
Go	✅
Java	✅
JavaScript	✅
PHP	✅
Python	✅	✅
Ruby	✅
Rust	✅
TypeScript	✅

コードナビゲーションを有効にするために、リポジトリで何かを構成する必要はありません。サポートされているこれらの言語の検索ベースのナビゲーション情報と正確なコードナビゲーション情報をすべてのリポジトリで自動的に抽出し、プログラミング言語が両方でサポートされている場合は、サポートされている 2 つのコードナビゲーションアプローチを切り替えることができます。

GitHub では、オープンソースの tree-sitter と stack-graphs ライブラリに基づいて 2 つのコードナビゲーションアプローチが開発されました。

検索ベース - リポジトリ全体のすべての定義と参照を検索して、特定の名前のエンティティを見つける
正確 - コード内の特定のポイントにあるクラス、関数、インポートされた定義のセットに基づいて定義と参照を解決する

これらのアプローチの詳細については、「正確なナビゲーションと検索ベースのナビゲーション」を参照してください。

将来のリリースでは、より正確な結果を得ることができるコードナビゲーションアプローチである、正確なコードナビゲーションが、より多くの言語について追加されます。

関数やメソッドの定義にジャンプする

ファイル内の関数またはメソッドの呼び出しをクリックすることで、同じリポジトリ内の関数またはメソッドの定義にジャンプできます。

[Jump-to-definition] タブ

関数とメソッドの全リファレンスを検索する

ファイル内の関数またはメソッドの呼び出しをクリックして [参照] タブをクリックすることで、同じリポジトリ内の関数またはメソッドのすべての参照を検索できます。

[Find all references] タブ

正確なナビゲーションと検索ベースのナビゲーション

GitHub でサポートされている一部の言語では、コード内の任意の時点で表示されるクラス、関数、インポートされた定義のセットに基づいて定義と参照を解決するアルゴリズム (オープンソース stack-graphs ライブラリに基づく) を使用する正確なコードナビゲーションにアクセスできます。 検索ベースのコードナビゲーションを使用する言語もあります。この場合は、リポジトリ全体のすべての定義と参照を検索して、特定の名前のエンティティを見つけます。どちらの方法も結果を見つけるのに効果的であり、どちらもコメントなどの不適切な結果を避けるようにしますが、特にリポジトリに同じ名前の複数のメソッドや関数が含まれている場合は、正確なコードナビゲーションを使用すると、より正確な結果が得られます。

正確なコードナビゲーションクエリで想定される結果が得られない場合は、表示されるポップオーバーの [検索ベース] リンクをクリックして、検索ベースのナビゲーションを実行できます。

正確なコードナビゲーションの結果が不正確と思われる場合は、サポート要求を提出できます。

リポジトリ間の正確なコードナビゲーション

リポジトリ間のコードナビゲーションは、正確なコードナビゲーションと依存関係グラフによってサポートされている言語で使用できます。詳細については、「依存関係グラフについて」を参照してください。リポジトリ間のコードナビゲーションを使用すると、プロジェクトによってインポートされた依存関係で定義されている関数や変数の定義にジャンプできます (その依存関係が GitHub によってホストされるリポジトリである場合)。現時点では、リポジトリ間のコードナビゲーションでは、すべての参照を検索する要求はサポートされていません。

リポジトリ間コードナビゲーションのスクリーンショット

コードナビゲーションのトラブルシューティング

コードナビゲーションが有効になっているにもかかわらず、関数とメソッドの定義へのリンクが表示されない場合:

コードナビゲーションは、アクティブなブランチに対してのみ機能します。ブランチにプッシュして、もう一度やり直してください。
コードナビゲーションが動作するのは、100,000 個未満のファイルをもつリポジトリのみです。

参考資料

「コードの検索」