Symboltransklusion
Skriv en wiki-länk till ett funktionsnamn så renderas funktionskroppen på plats med syntaxmarkering, hämtad direkt från dina källfiler. AST-driven extraktion fungerar för 40+ språk: Python, Swift, JavaScript, TypeScript, Go, Rust, Java, C, C++, Ruby, Kotlin med mera. Redigera källan, dokumentet uppdateras.
# Bädda in en funktion via namn
![[auth.py#validate_token]]Ohai extraherar funktionen validate_token från auth.py och renderar den inline med syntaxmarkering. När funktionen ändras uppdateras dokumentationen automatiskt.
Varför det spelar roll
Traditionell dokumentation föråldras. Du klistrar in kod i markdown, koden utvecklas, och plötsligt ljuger dokumentationen för dig. Symboltransklusion löser detta genom att behandla dina källfiler som den enda källan till sanning.
Till skillnad från radnummerreferenser som går sönder vid varje refaktorering använder symboltransklusion AST-parsning för att hitta kod via dess faktiska namn — funktioner, klasser, structs, konstanter. Byt namn på en fil, omorganisera din kod, lägg till nya metoder — så länge symbolnamnet finns kommer din dokumentation att förbli korrekt.
Användningsområden
API-dokumentation
Referera till dina verkliga funktionssignaturer, inte handskrivna approximationer som hamnar ur synk.
Arkitekturbeslutsregister
Bädda in koden du diskuterar i ADR:er. Exemplen förblir aktuella när kodbasen utvecklas.
Onboarding-guider
Visa nya utvecklare hur autentisering fungerar med live-kod de kan lita på matchar repot.
Kodgranskningar
Dra in specifika funktioner i en markdown-sammanfattning för asynkron granskning och diskussion.
Handledningar
Gå igenom verkliga implementationer. Läsarna kan lita på att kodexemplen alltid är aktuella.
Runbooks
Bädda in exakt den config eller det skript som ops behöver referera till under incidenter.
Språk som stöds
Tree-sitter AST-parsning för Python, Swift, JavaScript, TypeScript, Go, Rust, Java, C, C++, Ruby, Kotlin, PHP, Scala, Haskell, OCaml, Lua, Elixir, Bash med mera — plus sökvägsextraktorer för dataformat för JSON-nycklar, YAML-sökvägar, TOML-tabeller, plist-sökvägar, XML, CSS, SQL och vanlig text. 40+ format totalt.
Redo att prova dokumentation som aldrig föråldras?
Ladda ner för Mac