Apple: Swift-Doc-Compiler unterstützt beim Schreiben umfassender Dokumentationen

Das Open-Source-Projekt für Apples Programmiersprache Swift soll bereits in der kommenden Xcode-Version 13 enthalten sein.

Lesezeit: 2 Min.
In Pocket speichern
vorlesen Druckansicht Kommentare lesen 16 Beiträge

(Bild: Stokkete/Shutterstock.com)

Von
  • Madeleine Domogalla

Im Rahmen der Worldwide Developers Conference 2021 (WWDC21) hat Apple einen neuen Documentation Compiler für Frameworks und Packages der eigenen Programmiersprache Swift vorgestellt. Swift-DocC steht Entwicklerinnen und Entwicklern und nun frei zur Verfügung und bietet die Möglichkeit, umfangreiche Dokumentationen neben dem Code zu verfassen und Dokumentations-Webseiten für Swift-Codebases zu erstellen. Der Compiler unterstützt API-Dokumente, die als Code-Kommentare verfasst wurden, lange konzeptionelle Artikel, die in Markdown geschrieben sind sowie Tutorials mit integrierten Bildern.

Swift-DocC ist laut Blogbeitrag in der kommenden Xcode-Version 13 enthalten und steht Interessierten zudem als Open-Source-Paket zur Verfügung. Aktuell liegt Apples Entwicklungsumgebung in Version 12.5 vor. Der neue Compiler soll sich nahtlos in bestehende Workflows integrieren lassen und mit gängigen Tools und Entwicklungsumgebungen kompatibel sein. Der Compiler umfasst Werkzeuge und Bibliotheken, die Entwicklern beim Schreiben und Generieren von Dokumentationen auf verschiedenen Plattformen (z. B. Linux und macOS) unterstützten sollen.

Das docc-Befehlszeilentool ist offenbar bereits in Xcode 13 integriert und darauf ausgelegt, dass es sich in andere Build-Systeme wie SwiftPM integrieren lässt. Das Open-Source-Projekt besteht aus mehreren Komponenten, wie dem Compiler-Tool Swift-DocC, dem Swift-DocC-Renderer und den Bibliotheken Swift-Markdown und SymbolKit.

Lesen Sie mehr zur WWDC2021

Ziel der Entwicklung war gemäß Blogbeitrag, das Erstellen umfangreicher Referenzdokumentationen zu vereinfachen. Auch das Hinzufügen neuer Tutorials ist möglich, die Drittanbietern die Verwendung einer API verständlicher machen sollen. Diese Tutorials lassen sich offenbar wie Artikel in bestehende Dokumentationen einbinden. Entwicklerinnen und Entwickler haben zudem die Möglichkeit, eigene Dokumentation mit anderen zu verknüpfen, sie in logische Gruppen einzugliedern und Links zu anderen Dokumenten einzufügen.

Nähere Informationen zu Swift-DocC finden sich im offiziellen Blog zu Apples Programmiersprache.

(mdo)