Swift-DocC Artık Açık Kaynak Kodlu Durumda

Apple'in 2021 geliştirici etkinliğinde Swift paketleri ve framework'leri için yeni doküman derleyici olan Swift-DocC duyurulmuştu. Swift-DocC, Swift codebase'leri için detaylı doküman ve eğitimler içermektedir.


Görsel Referansı


Xcode 13'te Tools altında Swift-Doc dokümanlarını ve bileşenlerini bulabilirsiniz. Swift-Doc'un neden geliştirildiğine bir göz atalım;


Varolan Geliştirici Araçlarıyla Entegrasyon: Swift-Doc araçları geliştiricilerin kullandığı popüler kodlama araçları ve IDE'lere kolayca entegre olacaktır.

Zengin Dokümantasyon: 3. parti kütüphane geliştiricileri için kodlarının ve fonksiyonlarının davranışlarını anlatmak için etkili bir yöntem olması.

Üst Seviye Teknik Dokümantasyonun Desteklenmesi: Birçok geliştirici geçmişte üst düzey eğitim dokümanlarını API dokümanlarından ayrı olarak yazdı. Artık geliştiriciler üst düzey eğitim dokümanlarını ve API dokümanlarını Swift-Doc üzerinde yazabilecekler.

Yeni Kullanıcılar için Zengin Dokümantasyon: Eğitimler, yeni geliştiricilerin Swift'i öğrenmesinde önemli rol oynamaktadır. Makaleler gibi eğitimler da kolayca Swift-Doc'a entegre edilebilmektedir.

Belgeleri Bulmayı Kolaylaştırın: İyi dizinlenmiş dökümanları bulmak ve okumak kolaydır.


Genel Bakış


Swift-DocC geliştiricilere yardımcı olmak ve macOS, Linux gibi çoklu platformlar için kütüphaneler ve araçlar oluşturmayı sağlamaktadır. docc komut satırı Xcode 13'e entegre edilmiştir. Swift-DocC açık kaynak projesi birkaç bileşenden oluşur. Bu bileşenler;


Swift-DocC: Sistem tarafından okunabilen bir JSON dosyası oluşturmak için kaynak dosyalarını, bağımsız Markdown dosyalarını ve ilgili varlıkları işleyen belge derleyici araç.

Swift-DocC-Reader: JavaScript tabanlı Swift-DocC web uygulaması

Swift-MarkDown: Swift's markdown syntax'ını kolayca parse eder.

SymbolKit: Swift Compiler ile sembol grafik dosyalarını parse eden Swift kütüphanesi.

Kaynak dosyası dökümantasyon yorum satırları