Sembol Transklüzyonu
Dokümantasyonunuza satır numarasıyla değil, isimle canlı kod gömmek. Kaynağı düzenleyin, dokümantasyonunuz otomatik güncellenir.
# Bir fonksiyonu isme göre göm
![[auth.py#validate_token]]Ohai, auth.py dosyasından validate_token fonksiyonunu çıkarır ve sözdizimi vurgulamasıyla satır içi renderlar. Fonksiyon değiştiğinde dokümantasyonunuz otomatik güncellenir.
Neden önemli
Geleneksel dokümantasyon eskir. Kodu markdown'a kopyala-yapıştır yaparsınız, kod gelişir ve aniden dokümantasyonunuz size yalan söyler. Sembol transklüzyonu, kaynak dosyalarınızı tek gerçeklik kaynağı olarak ele alarak bunu düzeltir.
Her refactor'da bozulan satır numarası referanslarının aksine, sembol transklüzyonu kodu gerçek adıyla bulmak için AST ayrıştırması kullanır—fonksiyonlar, sınıflar, struct'lar, sabitler. Bir dosyayı yeniden adlandırın, kodunuzu yeniden düzenleyin, yeni metodlar ekleyin—sembol adı var olduğu sürece dokümantasyonunuz doğru kalır.
Kullanım Alanları
API Dokümantasyonu
Senkronizasyonu kaybeden elle yazılmış yaklaşıklamalar yerine gerçek fonksiyon imzalarınıza referans verin.
Mimari Karar Kayıtları
ADR'lerde tartıştığınız kodu gömmek. Kod tabanı geliştikçe örnekler güncel kalır.
İşe Alım Kılavuzları
Yeni geliştiricilere, depoyla eşleştiğine güvenebilecekleri canlı kodla kimlik doğrulamanın nasıl çalıştığını gösterin.
Kod İncelemeleri
Asenkron inceleme ve tartışma için belirli fonksiyonları markdown özetine çekin.
Eğitimler
Gerçek uygulamaları adım adım ilerleyin. Okuyucular kod örneklerinin her zaman güncel olduğuna güvenebilir.
Operasyon Kılavuzları
Operasyon ekibinin olaylar sırasında referans alması gereken tam config veya script'i gömmek.
Desteklenen Diller
Tree-sitter AST ayrıştırma ile 30+ dil. Hatta JSON anahtarları, YAML yolları ve TOML tabloları bile.
Asla eskimeyen dokümantasyonu denemeye hazır mısınız?
Mac için İndir