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

Promo : le MacBook Air M4 descend à 949 € pour tout le monde

09:02

• 1


Des iPad bradés : du modèle d’entrée de gamme à l’iPad Pro M4, des prix jamais vus

08:52

• 9


Meta a encore capturé un ingénieur IA d’Apple, le sixième depuis juillet

05:50

• 16


Le Flipper Zero, nouvelle arme des voleurs de voiture

21/08/2025 à 20:30

• 58


L'IA est là : un vrai assistant dans la poche

21/08/2025 à 20:30

• 11


Controverse Luc Julia : quel est le rôle exact du Français dans la naissance de Siri ?

21/08/2025 à 17:28

• 69


Refurb : jusqu'à - 300 € sur l'Apple Studio Display 5K avec des modèles VESA

21/08/2025 à 15:41

• 6


Promo : le MacBook Air M4 à seulement 899 € pour les étudiants !

21/08/2025 à 12:36

• 13


Le mode vidéo Action sur l'iPhone peut compenser les effets de la maladie de Parkinson

21/08/2025 à 11:25

• 7


Orange muscle son offre 5G+ fixe avec une Flybox compatible Wi-Fi 7

21/08/2025 à 10:53

• 11


South Park se paye la pomme de Tim Cook et de son cadeau en or de 24 carats à Donald Trump

21/08/2025 à 09:34

• 19


370 000 conversations en fuite chez xAI, dont certaines où Grok enfreint ses propres règles

20/08/2025 à 21:30

• 47


Test du Razer Thunderbolt 5 Dock : un pied dans le futur, un dans le passé

20/08/2025 à 21:00

• 5


Google dévoile quatre Pixel 10 aux améliorations nuancées

20/08/2025 à 20:37

• 107


D'importants correctifs de sécurité avec macOS 15.6.1 et iOS 18.6.2 [🆕 : iPadOS 17.7.10, macOS 14.7.8 et macOS 13.7.8 aussi proposés]

20/08/2025 à 19:48

• 29


Ces articles du Club iGen passent en accès libre : découvrez nos contenus premium

20/08/2025 à 17:01

• 2