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

Magazine des 25 ans de MacGeneration : dernier week-end pour passer commande !

07:40

• 13


Départs : Srouji et Cook, les prochains sur la liste ? Qui restera à la fin ?

06/12/2025 à 21:00

• 54


Nos coups de cœur et nos coups de gueule 2025

06/12/2025 à 10:00

• 82


Sortie de veille : les départs en cascade chez Apple, mauvaise nouvelle ou chance inespérée ?

06/12/2025 à 08:00

• 24


Promo : le MacBook Air M4 256 Go de retour à 874 € ! 🆕

05/12/2025 à 23:59

• 8


Les MacBook Pro M5 Pro, le MacBook A18 et les iPad/iPhone entrée de gamme dès janvier ?

05/12/2025 à 21:45

• 43


Promos : des AirPods 4 à 84 € et le pack de 4 AirTags à 65 € ! Des prix inédits en France

05/12/2025 à 21:39

• 7


Des MacBook Pro 14" comme neufs à moins de 900 € !

05/12/2025 à 21:19

• 0


Nouvelles spéculations sur la succession de Tim Cook… et sur sa santé

05/12/2025 à 17:55

• 56


X sanctionné par Bruxelles : amende de 120 millions d’euros pour non-respect du DSA

05/12/2025 à 16:13

• 55


Qu'utilisez-vous comme enceinte(s) sur votre bureau avec votre Mac ?

05/12/2025 à 15:05

• 141


Netflix achète les studios, films et séries de Warner Bros. et HBO pour 82,7 milliards de dollars 🆕

05/12/2025 à 13:46

• 102


30 % de réduction sur un écran OLED 4K LG de 32 pouces

05/12/2025 à 13:00

• 1


La Model 3 Standard est techniquement la voiture la moins chère jamais proposée par Tesla

05/12/2025 à 11:53

• 99


Une hausse des prix des Mac et des iPhone est-elle inévitable ?

05/12/2025 à 11:29

• 37


Pour tester le MTE, une nouvelle fonction de ses processeurs, Apple a créé un Rosetta « ARM »

05/12/2025 à 11:00

• 6