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.

Ajouter ce site dans Google News

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

Les Mac mini et Mac Studio 2026 font du genlock en USB-C pour synchroniser les caméras ou l'iPhone 17 Pro

17:35

• 0


Mac mini, Studio, Neo : Apple limite à deux exemplaires les commandes de certaines machines

16:58

• 9


Dans les coulisses de la pub du Mac mini M6, entièrement animée à la main

16:08

• 4


Promo : les AirPods 4 tombent à 108 €, les AirPods Pro 3 à 198 €

14:57

• 0


Test de la nouvelle chiffonnette Apple à 10 € : moins chère, moins bien ?

12:59

• 33


Le clavier de salon de Logitech, avec trackpad intégré, est en promo à 25 €

12:47

• 12


Non, le Mac Studio n'est pas PCIe 6.0, c'était sûrement une erreur dans le communiqué

11:26

• 10


Le Mac mini à 1 049 € prépare-t-il la hausse des iPhone 18 Pro ?

10:33

• 43


Faille iCloud Private Relay : CyberGhost VPN à -82 % pour protéger votre Mac sans attendre le correctif d'Apple 📍

09:50

• 0


BenQ lance une ScreenBar spécialement conçue pour l’iMac

09:37

• 9


Écrans pour Mac : les BenQ 4K dès 449 €, le Studio Display 2025 à 1 099 €

09:25

• 6


Robotaxi : Waymo prépare son entrée à Munich, sa première ville dans l’Union européenne

09:08

• 7


Cyberpunk 2077 deux fois plus rapide sur le Mac mini M6… sous conditions

08:20

• 27


De belles promotions sur les enceintes connectées de Sonos, dès 160 €

08:18

• 12


Apple Plans : les publicités font leur apparition aux Etats-Unis (sans option de désactivation)

08:16

• 42


Le Mac mini M4 d'entrée de gamme toujours à 699 € chez Amazon

07:50

• 9