Symbol-Transklusion
Betten Sie Live-Code nach Namen in Ihre Dokumentation ein, nicht nach Zeilennummer. Bearbeiten Sie den Quellcode, Ihre Dokumentation aktualisiert sich automatisch.
# Funktion nach Namen einbetten
![[auth.py#validate_token]]Ohai extrahiert die validate_token-Funktion aus auth.py und rendert sie inline mit Syntaxhervorhebung. Wenn sich die Funktion ändert, aktualisiert sich Ihre Dokumentation automatisch.
Warum es wichtig ist
Traditionelle Dokumentation veraltet. Sie kopieren Code in Markdown, der Code entwickelt sich weiter, und plötzlich lügt Ihre Dokumentation. Symbol-Transklusion behebt dies, indem sie Ihre Quelldateien als einzige Quelle der Wahrheit behandelt.
Im Gegensatz zu Zeilennummer-Referenzen, die bei jedem Refactoring kaputtgehen, verwendet Symbol-Transklusion AST-Parsing, um Code nach seinem tatsächlichen Namen zu finden – Funktionen, Klassen, Strukturen, Konstanten. Benennen Sie eine Datei um, organisieren Sie Ihren Code neu, fügen Sie neue Methoden hinzu – solange der Symbolname existiert, bleibt Ihre Dokumentation korrekt.
Anwendungsfälle
API-Dokumentation
Referenzieren Sie Ihre tatsächlichen Funktionssignaturen, nicht handgetippte Annäherungen, die aus dem Takt geraten.
Architecture Decision Records
Betten Sie den Code ein, den Sie in ADRs diskutieren. Die Beispiele bleiben aktuell, während sich die Codebasis entwickelt.
Onboarding-Leitfäden
Zeigen Sie neuen Entwicklern, wie Authentifizierung funktioniert, mit Live-Code, dem sie vertrauen können, dass er mit dem Repository übereinstimmt.
Code-Reviews
Ziehen Sie spezifische Funktionen in eine Markdown-Zusammenfassung für asynchrone Überprüfung und Diskussion.
Tutorials
Gehen Sie echte Implementierungen durch. Leser können darauf vertrauen, dass die Code-Beispiele immer aktuell sind.
Runbooks
Betten Sie die exakte Konfiguration oder das Skript ein, auf das Ops während Vorfällen verweisen muss.
Unterstützte Sprachen
Über 30 Sprachen via Tree-sitter AST-Parsing. Sogar JSON-Keys, YAML-Pfade und TOML-Tabellen.
Bereit, Dokumentation auszuprobieren, die niemals veraltet?
Für Mac laden