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

NimDoor : des hackers nord-coréens ciblent des entreprises de crypto via le Mac

11:57

• 1


Microsoft Office 2021 pour Mac à 49,99 € : une aubaine à ne pas rater pendant les soldes d’été 📍

11:07

• 0


Synology fait encore plus fort qu’Apple sur les prix des SSD

10:46

• 28


Flitedeck : un CarPlay Ultra mais pour les vélos de route

09:30

• 12


Promo : un switch Ethernet compact à moins de 15 €

08:34

• 3


Pas d’iPad pliable avant longtemps ? Apple mettrait le projet sur pause

07:13

• 5


Une multiprise avec ports USB bien pratique et compacte pour le bureau

02/07/2025 à 23:45

• 10


SFR : le retour à trois opérateurs se prépare chez Orange, Bouygues et Free

02/07/2025 à 17:43

• 59


Kernel Panic : que valent les premières bêtas d’iOS et macOS 26 ?

02/07/2025 à 17:00

• 17


Polysoft va bientôt proposer un kit pour augmenter le stockage des Mac Studio M3/M4

02/07/2025 à 16:44

• 25


Refurb : jusqu'à -370 € sur l'Apple Studio Display 5K

02/07/2025 à 16:28

• 6


Free propose un an de fibre optique à 19,99 € par mois avec la Freebox Revolution Light

02/07/2025 à 11:59

• 61


Produits Apple : vers une baisse de prix à la rentrée grâce à la faiblesse du dollar ?

02/07/2025 à 11:38

• 37


Apple Store : le crédit à 0 % prolongé cet été

02/07/2025 à 10:14

• 33


Stockage cloud : l’offre pCloud Lifetime avec 70 % de remise jusqu’au 15 juillet 📍

02/07/2025 à 08:08

• 0


Apple fait une nouvelle mise à jour de son antimalware XProtect

01/07/2025 à 22:13

• 11