Sobre a navegação do código no GitHub
A navegação por código ajuda você a ler, navegar e compreender o código mostrando e vinculando definições de uma entidade nomeada correspondente a uma referência a essa entidade, além das referências correspondentes à definição de uma entidade.
A navegação no código usa a biblioteca de código aberto tree-sitter. As linguagens a seguir dão suporte à navegação de código.
- Bash
- C
- C#
- C++
- CodeQL
- Elixir
- Go
- JSX
- Java
- JavaScript
- Lua
- PHP
- Buffers de protocolo
- Python
- R
- Ruby
- Rust
- Scala
- Starlark
- Swift
- TypeScript
Você não precisa configurar nada no seu repositório para habilitar a navegação do código. Extrairemos automaticamente informações de navegação de código para essas linguagens com suporte em todos os repositórios.
O GitHub desenvolveu uma abordagem de navegação de código com base na biblioteca tree-sitter de código aberto que pesquisa todas as definições e referências em um repositório para encontrar entidades com um determinado nome.
É possível usar atalhos de teclado para navegar em um arquivo de código. Para saber mais, confira Atalhos do teclado.
Usar o painel de símbolos
Agora, com o painel de símbolos, é possível exibir e navegar rapidamente por símbolos como funções ou classes no código. É possível pesquisar um símbolo em um único arquivo, em todos os arquivos de um repositório ou até mesmo em todos os repositórios públicos no GitHub.
A pesquisa de símbolo é um recurso da pesquisa de código. Para saber mais, confira Entender a sintaxe de pesquisa de código do GitHub.
-
Selecione um repositório e navegue até um arquivo que contenha símbolos.
-
Para abrir o painel de símbolos, acima do conteúdo do arquivo, clique em .
Como alternativa, é possível abrir o painel de símbolos clicando em um símbolo elegível no arquivo. Os símbolos clicáveis são realçados em amarelo quando você passa o mouse sobre eles.
-
Clique no símbolo que você deseja encontrar no painel de símbolos ou no próprio arquivo.
- Para pesquisar um símbolo no repositório como um todo, clique no painel de símbolos e depois em Pesquisar este símbolo neste repositório. Para procurar um símbolo em todos os repositórios no GitHub, clique em Todos os repositórios.
-
Para navegar entre as referências de um símbolo, clique em ou em .
-
Para navegar para uma referência específica a um símbolo, clique em um resultado da pesquisa de símbolo em In this file.
-
Para sair da pesquisa de um símbolo específico, clique em All Symbols.
Pular para a definição de uma função ou método
Você pode pular para uma definição de uma função ou método dentro do mesmo repositório, clicando na chamada dessa função ou método em um arquivo.
Localizar todas as referências de uma função ou método
Encontre todas as referências de uma função ou de um método dentro do mesmo repositório clicando na função ou na chamada de método de um arquivo.
Solução de problemas na navegação de código
Se a navegação de código estiver habilitada para você, mas você não vir links para as definições de funções e métodos:
- A navegação de código só funciona para branches ativos. Faça um push no branch e tente novamente.
- O código de navegação só funciona para repositórios com menos de 100.000 arquivos.