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.

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é !

Rejoignez le Club iGen

Soutenez le travail d'une rédaction indépendante.

Rejoignez la plus grande communauté Apple francophone !

S'abonner

Les activités en direct dans macOS 26 ne demandent pas iOS 26 et pourraient fonctionner en Europe

16/06/2025 à 21:23

• 8


Découverte de Téléphone dans iOS 26 : nouvelle interface, appels inconnus, portages sur l’iPad et le Mac

16/06/2025 à 20:35

• 15


France Identité : l’intégration de la carte grise disponible en bêta

16/06/2025 à 19:51

• 96


La publicité s’infiltre finalement dans WhatsApp

16/06/2025 à 19:51

• 44


Comme promis, Apple sort de nouvelles bêtas… pour iOS 18.6 et macOS 15.6

16/06/2025 à 19:20

• 12


Bug amusant ou blague non assumée ? Une mise à jour de Windows 11 ressuscite le son de démarrage de Vista

16/06/2025 à 18:57

• 16


Un triple écran 15,6 pouces, qui promet l'équivalent de 43 pouces en 48:9

16/06/2025 à 18:07

• 3


Shadow, le PC dans le cloud, fait évoluer ses offres avec une pseudo RTX 4060

16/06/2025 à 16:58

• 19


Le PCI-Express 7.0 (256 Go/s) arrive alors que le PCIe 6.0 ne va pas se démocratiser avant 2030

16/06/2025 à 15:39

• 8


Grosse panne sur les réseaux mobile et fixe de SFR

16/06/2025 à 14:54

• 54


Un Steam Deck caché dans un clavier Apple pour l'utiliser avec des lunettes AR

16/06/2025 à 13:00

• 13


En Allemagne, le Schleswig-Holstein va abandonner les outils Microsoft comme Teams ou Office

16/06/2025 à 11:38

• 58


macOS Tahoe change plus facilement la couleur des LED des manettes de PlayStation

16/06/2025 à 10:45

• 14


Choisissez le moniteur parfait pour votre Mac

16/06/2025 à 09:09

• 0


GlassBar opacifie déjà la barre des menus de macOS Tahoe

16/06/2025 à 09:04

• 17


Nouveautés d’iOS 26, macOS Tahoe, Liquid Glass… Tous nos articles pour tout savoir sur la WWDC 2025

16/06/2025 à 06:00

• 12