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é !
illustration magazine 25 ans

MacGeneration a 25 ans !

Participez à la fête et découvrez l’histoire de votre site favori en précommandant notre magazine exclusif.

Je précommande le magazine

Apple et la mémoire flash, une longue histoire d'amour

11:00

• 6


Sortie de veille : télé Apple et iPhone 17 ultra-fin, des rumeurs folles ou crédibles ?

08:00

• 0


Les meilleures promos du Black Friday : AirPods Pro 2, iPad 10, serrure connectée…

07:30

• 14


Intrusion informatique, quand une entreprise joue le jeu de la communication ouverte

22/11/2024 à 20:45

• 15


Le SSD de certains MacBook Pro M4 Max atteint presque 11 Go/s

22/11/2024 à 20:30

• 14


Test du système mesh Wi-Fi 7 Netgear Orbi 970 : une poignée de mégabits, pour quelques centaines d’euros de plus

22/11/2024 à 17:00

• 10


Décodeur Orange : mise en veille automatique du boitier par le téléviseur

22/11/2024 à 16:30

• 27


macOS 15.2 : Safari dédouble ses fonctions d'import de données

22/11/2024 à 15:02

• 5


Buy Now : un documentaire sur la surconsommation avec le CEO d’iFixit et un ancien d’Apple

22/11/2024 à 12:15

• 71


Protégez votre Mac pour seulement 2,03 €/mois avec CyberGhost VPN : l'offre Black Friday à ne pas manquer ! 📍

22/11/2024 à 11:49


OpenAI envisagerait de lancer un navigateur web

22/11/2024 à 11:15

• 23


Black Friday : le Creative Cloud ainsi que les apps Affinity et DxO jusqu’à - 55 %

22/11/2024 à 10:10

• 13


Palworld est en précommande sur Mac, la sortie repoussée à 2025 🆕

22/11/2024 à 09:47

• 19


Black Friday : de bonnes remises sur les MacBook Pro M3

22/11/2024 à 09:47

• 4


Publicité : l'iPhone 16 Pro décolle à plat grâce à sa puce surpuissante 🆕

22/11/2024 à 09:33

• 15


Le Bitcoin flirte avec les 100 000 $

22/11/2024 à 09:00

• 110