Transclusión de símbolos
Incruste código en vivo en su documentación por nombre, no por número de línea. Edite el código fuente, su documentación se actualiza automáticamente.
# Incrustar una función por nombre
![[auth.py#validate_token]]Ohai extrae la función validate_token de auth.py y la renderiza en línea con resaltado de sintaxis. Cuando la función cambia, su documentación se actualiza automáticamente.
Por qué importa
La documentación tradicional se vuelve obsoleta. Usted copia y pega código en markdown, el código evoluciona y de repente su documentación le está mintiendo. La transclusión de símbolos soluciona esto al tratar sus archivos fuente como la única fuente de verdad.
A diferencia de las referencias por número de línea que se rompen con cada refactorización, la transclusión de símbolos usa análisis AST para encontrar código por su nombre real: funciones, clases, estructuras, constantes. Renombre un archivo, reorganice su código, agregue nuevos métodos; mientras el nombre del símbolo exista, su documentación permanece precisa.
Casos de uso
Documentación de API
Referencie sus firmas de función reales, no aproximaciones escritas a mano que se desincronicen.
Registros de decisiones de arquitectura
Incruste el código que está discutiendo en los ADR. Los ejemplos se mantienen actualizados a medida que evoluciona el código base.
Guías de incorporación
Muestre a los nuevos desarrolladores cómo funciona la autenticación con código en vivo en el que pueden confiar que coincide con el repositorio.
Revisiones de código
Extraiga funciones específicas en un resumen de markdown para revisión y discusión asíncrona.
Tutoriales
Recorra implementaciones reales. Los lectores pueden confiar en que los ejemplos de código siempre están actualizados.
Manuales de operaciones
Incruste la configuración o el script exacto que el equipo de operaciones necesita consultar durante incidentes.
Lenguajes soportados
Más de 30 lenguajes mediante análisis AST de Tree-sitter. Incluso claves JSON, rutas YAML y tablas TOML.
¿Listo para probar documentación que nunca se vuelve obsoleta?
Descargar para Mac