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

Un humanoïde boucle le semi-marathon de Pékin en 2h40

20/04/2025 à 19:05

• 17


Incogni : la vie privée, enfin prise au sérieux (par quelqu’un d’autre que vous) 📍

20/04/2025 à 14:00

• 0


À la découverte de l’écosystème UniFi, l’équipement réseau des pros accessible au grand public

20/04/2025 à 10:00

• 64


Promo : les prix des MacBook Air M4 et MacBook Pro M4 continuent de baisser - jusqu'à 10 % de remise ! 🆕

19/04/2025 à 15:56

• 10


Sortie de veille : le futur de l’iPad se trouve-t-il dans le Mac ?

19/04/2025 à 08:00

• 20


Quand Apple a sorti... une molaire

18/04/2025 à 22:15

• 53


Redonnez vie à vos photos floues : l'IA d’Aiarty passe à la vitesse supérieure 📍

18/04/2025 à 22:01

• 0


Clap de fin pour Mythic Quest, qui voit son épisode final modifié pour mieux clore la série

18/04/2025 à 21:30

• 33


Un support pour Mac mini M4 qui en bouche un coin(-coin)

18/04/2025 à 20:45

• 50


Choosy permet de choisir un navigateur web différent en fonction du lien à ouvrir

18/04/2025 à 18:00

• 17


Doom, Mario, Civilization : les IA génératives peuvent-elles terminer des jeux des années 90 ?

18/04/2025 à 17:30

• 11


Les agences immobilières peuvent intégrer DossierFacile sur leur site

18/04/2025 à 15:04

• 9


Assistant d’évaluation : un rapport de bug peut servir à entraîner Apple Intelligence

18/04/2025 à 12:43

• 4


macOS 15.4 ne blanchit plus le fond de l'écran

18/04/2025 à 12:05

• 5


Netflix augmente ses prix en France sur fond de bons résultats

18/04/2025 à 08:11

• 199


Les dernières publicités de Beats vantent avec humour les mérites des nouveaux câbles colorés de la marque

18/04/2025 à 08:03

• 26