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

Netflix va s’arrêter sur les Livebox Play, Orange propose un échange gratuit

15:41

• 0


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

14:33

• 89


Bon plan : un bon d'achat Amazon de 10 € offert pour l'achat d'une carte cadeau Apple d'au moins 100 €

14:32

• 1


Portrait : John Ternus, l’homme qui visse le futur d’Apple

14:04

• 14


Un nouveau modèle de Raspberry Pi, le Compute Module Zero, uniquement pour la Chine

12:45

• 10


La RATP doit aller au tribunal pour faire corriger le bug de 2038 dans le RER A

11:25

• 15


Promo : jusqu’à 60 % de réduction sur les produits réseau de la gamme UniFi

09:23

• 6


Pas d'écran, mais de l'IA : voici à quoi pourraient ressembler les premières lunettes d'Apple

07:50

• 37


IKEA prépare la mise en rayon complète de sa nouvelle gamme Matter pour janvier 2026

07:50

• 49


Free tease l’arrivée de l’Apple Watch : c'est imminent !

06:34

• 65


Twitter pourrait bien ressusciter, au nez et à la barbe de X

06:19

• 96


Apple Music et Apple TV indisponibles pour certains utilisateurs

10/12/2025 à 21:57

• 9


120 Hz, HDR, A19 : du code laisse entrevoir les caractéristiques du prochain Studio Display

10/12/2025 à 21:00

• 29


Test de l'écran 5K de Japannext : pas de fioritures et un prix intéressant

10/12/2025 à 20:30

• 11


Le détecteur de présence FP300 d’Aqara joue à cache-cache : de nouveau disponible, mais pour combien de temps ?

10/12/2025 à 18:37

• 7


Les États-Unis veulent contrôler les profils des réseaux sociaux des touristes

10/12/2025 à 18:13

• 150