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

Le MacBook A18 Pro entrerait en production à la fin de l’année, pour un prix d’entrée de 599 dollars

17/09/2025 à 21:30

• 22


macOS 26 ne veut pas s’installer sur les Mac Studio M3 Ultra

17/09/2025 à 20:00

• 27


Apple ne devrait pas avoir la primeur sur la gravure en 1,6 nm de TSMC : Nvidia passerait avant

17/09/2025 à 18:30

• 11


macOS Tahoe : plus besoin de KVM pour se connecter à un Mac après une panne de courant

17/09/2025 à 17:15

• 5


Revue de tests de l’iPhone Air : le design séduit, les compromis interrogent

17/09/2025 à 16:32

• 96


Revue des tests des iPhone 17 Pro : ils chauffent moins, mais ne réinventent pas la roue

17/09/2025 à 16:20

• 43


Est-ce que mettre la TV en pause, c'est de la copie privée ? SFR pense que non, Copie France pense que si

17/09/2025 à 16:20

• 80


macOS Tahoe : Apple simplifie la configuration de FileVault en augmentant sa sécurité

17/09/2025 à 15:30

• 24


Le codec AV2 annoncé, alors qu'Apple peine à prendre en charge massivement l'AV1

17/09/2025 à 13:45

• 23


tvOS 26 à l’essai : notre prise en main des nouveautés pour l’Apple TV

17/09/2025 à 13:15

• 18


Kuo : Apple lancera un MacBook Pro à écran OLED tactile fin 2026

17/09/2025 à 12:07

• 45


10 € de réduction sur l'ensemble des coques Apple pour les nouveaux iPhone

17/09/2025 à 10:50

• 0


Promo : le MacBook Air M4 15" avec 24 Go de RAM et 512 Go de stockage à son prix le plus bas

17/09/2025 à 10:39

• 4


macOS Tahoe peut se connecter automatiquement au partage de connexion d’un iPhone

17/09/2025 à 09:35

• 22


iOS 26 : RCS, nouveau Siri, météo par satellite… le programme des prochains mois

17/09/2025 à 09:00

• 37


4K, 5K, 6K : le guide des meilleurs écrans externes pour votre Mac

17/09/2025 à 08:40

• 35