Acerca de la navegación de código en GitHub
La navegación de código facilita la lectura, navegación y comprensión del código mostrando las definiciones de una entidad correspondiente a una referencia dada, así como mostrando las referencias que corresponden a la definición de esa entidad.
La navegación por código usa la biblioteca open source tree-sitter. Los siguientes lenguajes admiten la navegación de código.
- Bash
- C
- C#
- C++
- CodeQL
- Elixir
- Go
- JSX
- Java
- JavaScript
- Lua
- PHP
- Búferes de protocolo
- Python
- R
- Ruby
- Rust
- Scala
- Starlark
- Swift
- Typescript
No necesitas configurar nada en tu repositorio para habilitar la navegación de código. Extraeremos automáticamente información de navegación del código de estos lenguajes compatibles en todos los repositorios.
GitHub ha desarrollado un enfoque de navegación de código basado en la biblioteca open source tree-sitter biblioteca que busca todas las definiciones y referencias en un repositorio para buscar entidades con un nombre determinado.
Puedes usar métodos abreviados de teclado para navegar dentro de un archivo de código. Para más información, consulta Atajos de teclado.
Uso del panel de símbolos
Ahora puedes ver y navegar rápidamente entre símbolos, como funciones o clases, en tu código con el panel de símbolos. Puedes buscar un símbolo en un único archivo, en todos los archivos de un repositorio o incluso en todos los repositorios públicos de GitHub.
La búsqueda de símbolos es una característica de la búsqueda de código. Para más información, consulta Comprendiendo la sintaxis de búsqueda de código en GitHub.
-
Selecciona un repositorio y navega a un archivo que contenga símbolos.
-
Para abrir el panel de símbolos, encima del contenido del archivo, haga clic en .
De forma alternativa, puedes abrir el panel de símbolos haciendo clic en un símbolo reconocido en el archivo. Los símbolos en los que se puede hacer clic se resaltan en amarillo al pasar el puntero sobre ellos.
-
Haz clic en el símbolo que quieres buscar en el panel de símbolos o en el propio archivo.
- Para buscar un símbolo en el conjunto del repositorio, en el panel de símbolos, haga clic en Buscar este símbolo en este repositorio. Para buscar un símbolo en todos los repositorios de GitHub, haz clic en todos los repositorios.
-
Para navegar entre las referencias a un símbolo, haz clic en o .
-
Para ir a una referencia específica a un símbolo, haz clic en un resultado de la búsqueda de símbolos en In this file.
-
Para salir de la búsqueda de un símbolo específico, haz clic en Todos los símbolos.
Saltar a la definición de una función o método
Puedes saltar a una definición de función o de método dentro del mismo repositorio si das clic en la llamada a dicha función o método dentro de un archivo.
Buscar todas las referencias de una función o método
Puedes encontrar todas las referencias para una función o método dentro del mismo repositorio haciendo clic en la llamada de método o función en un archivo.
Solución de problemas de la navegación del código
Si se habilitó la navegación de código pero no ves los enlaces a las definiciones de las funciones y métodos:
- La navegación de código solo funciona para las ramas activas. Sube a la rama e intenta de nuevo.
- La navegación de código funciona únicamente para los repositorios que tienen menos de 100,000 archivos.