Сведения о навигации по коду на GitHub
Навигация по коду помогает перемещаться по коду, читать и понимать его благодаря отображению связанных определений именованной сущности, соответствующих ссылке на эту сущность, а также ссылок, соответствующих определению сущности.
Навигация по коду использует библиотеку open source tree-sitter. Следующие языки поддерживают навигацию по коду.
- Bash
- C
- C#
- C++
- CodeQL
- Elixir
- Go
- JSX
- Java
- JavaScript
- Lua
- PHP
- Protocol Buffers
- Python
- R
- Ruby
- Rust
- Scala
- Starlark
- Swift
- Typescript
Для включения навигации по коду в репозитории не требуется ничего настраивать. Мы автоматически извлеким сведения о навигации кода для этих поддерживаемых языков во всех репозиториях.
GitHub разработала подход навигации по коду на основе библиотеки open source tree-sitter, которая ищет все определения и ссылки по репозиторию для поиска сущностей с заданным именем.
Сочетания клавиш можно использовать для навигации в файле кода. Дополнительные сведения см. в разделе сочетания клавиш;.
Использование области символов
Теперь вы можете быстро просматривать и перемещаться между символами, такими как функции или классы в коде, с помощью области символов. Вы можете найти символ в одном файле, во всех файлах в репозитории или даже во всех общедоступных репозиториях на GitHub.
Поиск символов — это функция поиска кода. Дополнительные сведения см. в разделе Понимание синтаксиса поиска кода в GitHub.
-
Выберите репозиторий, а затем перейдите к файлу, содержащему символы.
-
Чтобы открыть область символов над содержимым файла, щелкните .
Кроме того, можно открыть область символов, щелкнув подходящий символ в файле. Нажатые символы выделены желтым цветом при наведении на них указателя мыши.
-
Щелкните символ, который вы хотите найти в области символов или в самом файле.
- Чтобы найти символ в репозитории в целом, в области символов нажмите кнопку "Поиск этого символа" в этом репозитории. Чтобы найти символ во всех репозиториях на GitHub, щелкните все репозитории.
-
Чтобы перейти между ссылками на символ, щелкните или .
-
Чтобы перейти к определенной ссылке на символ, щелкните результат поиска символов в разделе В этом файле.
-
Чтобы выйти из поиска определенного символа, щелкните Все символы.
Переход к определению функции или метода
Вы можете перейти к определению функции или метода в том же репозитории, щелкнув вызов функции или метода в файле.
Поиск всех ссылок на функцию или метод
Все ссылки на функцию или метод можно найти в одном репозитории, щелкнув вызов функции или метода в файле.
Устранение неполадок навигации по коду
Если навигация по коду включена, но ссылки на определения функций и методов не отображаются:
- Навигация по коду работает только для активных ветвей. Выполните отправку в ветвь и повторите попытку.
- Навигация по коду работает только для репозиториев с менее чем 100 000 файлов.