AccueilActualités informatiqueApple : Swift-Doc-Compiler prend en charge la rédaction de documentations complètes

Apple : Swift-Doc-Compiler prend en charge la rédaction de documentations complètes

Dans le cadre de la Worldwide Developers Conference 2021 (WWDC21), Apple a dévoilé un nouveau compilateur de documentation pour les frameworks et les paquets de son propre langage de programmation Swift. Swift-DocC est mis gratuitement à la disposition des développeurs et offre désormais la possibilité d’écrire une documentation étendue en même temps que le code et de créer des sites web de documentation pour les bases de code Swift. Le compilateur prend en charge les documents d’API écrits sous forme de commentaires de code, les longs articles conceptuels écrits en Markdown et les didacticiels avec images intégrées.

Sommaire

Selon un billet de blog, Swift-DocC est inclus dans la prochaine version 13 de Xcode et est également disponible pour les parties intéressées en tant que paquet open source. Actuellement, l’environnement de développement d’Apple est disponible en version 12.5. Le nouveau compilateur est censé s’intégrer de manière transparente dans les flux de travail existants et être compatible avec les outils et les environnements de développement courants. Le compilateur comprend des outils et des bibliothèques pour aider les développeurs à écrire et à générer de la documentation sur différentes plateformes (par exemple, Linux et macOS).

Le site docc-L’outil de ligne de commande est apparemment déjà intégré à Xcode 13 et conçu pour s’intégrer à d’autres systèmes de construction tels que SwiftPM. Le projet open source se compose de plusieurs éléments, tels que l’outil de compilation Swift-DocC, le moteur de rendu Swift-DocC et les bibliothèques Swift-Markdown et SymbolKit.

En savoir plus sur la WWDC2021

  • À l’approche de la WWDC 2021 : les développeurs agacés par la défense de l’App Store par Apple
  • iOS 15, macOS 12 et MacBooks : ce que nous attendons de la keynote de la WWDC 2021 d’Apple.
  • La keynote de la WWDC 2021 d’Apple dans le liveticker : iOS 15, macOS 12 et plus encore.
  • À partir de 19 heures : iOS 15, macOS 12 et plus encore dans le téléscripteur et le commentaire en direct de la WWDC.
  • iOS 15 et iPadOS 15 : FaceTime s’ouvre pour Android et Windows
  • macOS 12 obtient des raccourcis et facilite l’échange de données
  • Apple lance un service en nuage pour l’intégration continue via Xcode
  • Aperçu général de la WWDC21

Selon le billet de blog, l’objectif de ce développement était de simplifier la création d’une documentation de référence étendue. Il est également possible d’ajouter de nouveaux tutoriels destinés à rendre l’utilisation d’une API plus compréhensible pour les fournisseurs tiers. Ces didacticiels peuvent apparemment être intégrés dans la documentation existante, comme les articles. Les développeurs ont également la possibilité de relier leur propre documentation à d’autres, en la plaçant dans des groupes logiques et en insérant des liens vers d’autres documents.

Vous trouverez de plus amples informations sur Swift-DocC sur le blog officiel du langage de programmation d’Apple.

Plus d'articles