Ouvrir le menu principal

MacGeneration

Recherche

DocC : aperçu de la documentation de code Swift maintenant open source

Florent Morin

lundi 18 octobre 2021 à 14:00 • 3

Logiciels

Lors de la WWDC 2021, Apple a présenté son outil de documentation de code DocC. Celui-ci étant devenu open source il y a quelques jours, c'est l’occasion parfaite pour faire le tour de l’outil et de ses différents composants.

L'icône de DocC

Jusqu’à présent, les développeurs Swift utilisaient la syntaxe propre à Xcode qui permettait d’avoir une documentation accessible directement depuis l’éditeur. Au fur et à mesure des versions, cette syntaxe s’est enrichie en supportant notamment la populaire syntaxe Markdown enrichie d’une coloration syntaxique du code. De manière générale, ça fonctionne bien tant qu’on reste dans le cadre de Xcode.

La documentation de code au sein de Xcode

Mais il est parfois utile d’avoir une documentation plus élaborée, avec du code de démo détaillé dans des fichiers dédiés et des illustrations. C’est d’ailleurs ce que propose Apple pour ses propres API, mais il n'y avait rien pour Swift et les développeurs ont conçu leurs propres outils comme Jazzy ou SwiftDoc.

DocC a finalement été présenté par Apple lors de la WWDC21 comme la solution officielle pour documenter le code Swift, au point d’être utilisé pour les propres besoins du constructeur. L’outil est largement inspiré de ce qui existait jusqu’alors dans la communauté open source.

Soutenez MacGeneration sur Tipeee

Cet article est réservé aux membres du Club iGen


Rejoignez la plus grande communauté Apple francophone et soutenez le travail d'une rédaction indépendante. Le Club iGen, c'est:

  • des articles de qualité rien que pour vous
  • un podcast exclusif
  • pas de publicité
  • un site dédié !

MacGeneration a besoin de vous

Vous pouvez nous aider en vous abonnant ou en nous laissant un pourboire

Soutenez MacGeneration sur Tipeee

La folie des bilans de l’année : même ma voiture propose son « wrapped »

10:50

• 16


Un écran nomade 15" USB-C/HDMI pour moins de 100 €

10:40

• 0


Pénurie de mémoire : des fabricants de PC s’apprêteraient à augmenter leurs prix

10:03

• 18


Apple et les analystes misent sur un lancement réussi du premier iPhone pliant à l’automne 2026

08:59

• 21


Oubliez Google : le véritable rival d’OpenAI pour Sam Altman, c’est Apple

08:27

• 51


Google Maps se met enfin à niveau : Plans et Waze faisaient déjà ça en 2016

07:14

• 72


Pebble lance l’Index 01, la bague qui note ce que votre cerveau oublie

06:30

• 28


Jeff Williams en route pour le conseil d’administration de Disney

05:57

• 9


Le paiement fractionné de Klarna s’intègre à Apple Pay

09/12/2025 à 21:25

• 47


Que faire si Apple ou UPS perd votre colis de retour ?

09/12/2025 à 20:30

• 46


Amazon répète que les frais de port obligatoires nuisent à la lecture en France

09/12/2025 à 18:00

• 168


Ford choisit Renault plutôt que Volkswagen pour proposer des citadines électriques en Europe

09/12/2025 à 16:24

• 60


QuickNetStats surveille l’état de votre connexion à internet depuis la barre des menus de macOS

09/12/2025 à 14:49

• 11


MacBook Air M2 : le modèle 16 Go revient à 750 € ! 🆕

09/12/2025 à 12:44

• 87


Euria : Infomaniak lance un concurrent à ChatGPT, une IA hébergée en Suisse qui chauffe aussi des logements

09/12/2025 à 12:15

• 18


Bon plan : les best-sellers du Black Friday sont de retour à prix cassés pour Noël

09/12/2025 à 11:25

• 3