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

Mistral Large 3 et Ministral 3 apportent un vent de fraicheur aux modèles d’IA ouverts

02/12/2025 à 23:54

• 5


Séries Apple TV : quand la politique dicte les annulations ou reports

02/12/2025 à 22:17

• 32


C'est déjà Noël chez Cultura : le petit guide pour trouver LE cadeau qui fera mouche 📍

02/12/2025 à 20:33

• 0


Windows 10 (oui oui), bilan Apple Silicon, tests… Les articles du Club iGen publiés en novembre

02/12/2025 à 18:00

• 13


Samsung annonce un SSD externe qui contient un peu d'un smartphone Galaxy

02/12/2025 à 17:15

• 7


Un nouvel adaptateur CR2032 pour empêcher les piles d'exploser dans les Macintosh

02/12/2025 à 15:15

• 10


Linus monte le PC de Linus en vidéo

02/12/2025 à 13:00

• 22


Alan améliore l’accessibilité de macOS en encadrant l’application active

02/12/2025 à 11:15

• 6


Les cours de programmation de Purple Giraffe sont en promotion

02/12/2025 à 11:00

• 0


Matter, Thread et prix serrés : IKEA dévoile sa nouvelle gamme de produits connectés

02/12/2025 à 10:52

• 73


Le MacBook Air M2 plonge à 748 € sur Amazon (avec 16 Go de RAM) 🆕

02/12/2025 à 09:10

• 84


La saga Traqués continue : Apple ne trouverait pas les ayants droit du roman plagié

02/12/2025 à 07:52

• 37


Amar Subramanya face au chaos : mission impossible pour le nouveau patron de l'IA d'Apple ?

02/12/2025 à 07:38

• 50


Ducklet s’éteint : le petit client SQLite natif pour macOS tire sa révérence

02/12/2025 à 07:15

• 9


DaVinci Resolve prend maintenant en charge le montage 32K sur les Mac M5

02/12/2025 à 06:45

• 6


John Giannandrea, responsable de l'IA, va quitter Apple et être remplacé par un spécialiste issu de chez Microsoft

01/12/2025 à 23:47

• 44