Swift Academy · Leçon

CustomStringConvertible

Définissez une description lisible pour vos types.

CustomStringConvertible est une leçon Swift Academy gratuite sur CoddyKit. Ceci est la leçon 1 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Swift Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Swift Academy comprend 4 leçons au total.

Qu’est-ce que CustomStringConvertible ?

Ce protocole vous permet de contrôler la façon dont votre type s’affiche lorsqu’il est imprimé ou interpolé dans une chaîne. Vous fournissez une propriété description.

Le résultat par défaut est peu lisible

Sans ce protocole, les structures affichent leur forme complète avec tous leurs membres, ce qui est souvent peu lisible :

struct Point { let x: Int; let y: Int }
print(Point(x: 1, y: 2))  // Point(x: 1, y: 2)

Ajouter description

Adoptez le protocole et fournissez var description: String :

struct Point: CustomStringConvertible {
    let x: Int
    let y: Int
    var description: String { "(\(x), \(y))" }
}
print(Point(x: 1, y: 2))  // (1, 2)

Utilisé par print et String(describing:)

Votre description est utilisée par print et l’interpolation de chaînes :

struct Money: CustomStringConvertible {
    let cents: Int
    var description: String { "$\(Double(cents) / 100)" }
}
let m = Money(cents: 250)
print("price is \(m)")  // price is $2.5

description et propriétés directes

description sert à produire un texte lisible par un humain et destiné à l’utilisateur. Elle n’est pas conçue pour être reconvertie en valeur — c’est un autre sujet, pris en charge par Codable. Veillez à ce qu’elle reste lisible.

Formater une énumération

Donnez des noms conviviaux aux énumérations :

enum Suit: CustomStringConvertible {
    case hearts, spades
    var description: String {
        switch self {
        case .hearts: return "Hearts"
        case .spades: return "Spades"
        }
    }
}
print(Suit.hearts)  // Hearts

Composer des descriptions

Construisez une description à partir des descriptions des membres :

struct Card: CustomStringConvertible {
    let rank: Int
    let suit: String
    var description: String { "\(rank) of \(suit)" }
}
let cards = [Card(rank: 1, suit: "H"), Card(rank: 13, suit: "S")]
print(cards.map { $0.description })  // ["1 of H", "13 of S"]

Dans les collections

L’affichage d’une collection appelle la description de chaque élément :

struct Tag: CustomStringConvertible {
    let name: String
    var description: String { "#\(name)" }
}
print([Tag(name: "swift"), Tag(name: "ios")])  // [#swift, #ios]

L’interpolation utilise description

L’interpolation de chaînes récupère automatiquement votre description :

struct Temperature: CustomStringConvertible {
    let celsius: Int
    var description: String { "\(celsius)C" }
}
let t = Temperature(celsius: 21)
print("Now: \(t)")  // Now: 21C

Rester léger

description peut être appelée fréquemment (journalisation, débogage). Évitez d’y effectuer des opérations coûteuses ; calculez une chaîne simple à partir des propriétés stockées.

struct ID: CustomStringConvertible {
    let value: Int
    var description: String { "ID#\(value)" }
}
print(ID(value: 42))  // ID#42

Formatage conditionnel

description peut choisir une branche selon l’état afin de produire un texte naturel :

struct Stock: CustomStringConvertible {
    let count: Int
    var description: String {
        count == 0 ? "Out of stock" : "\(count) in stock"
    }
}
print(Stock(count: 0))  // Out of stock
print(Stock(count: 5))  // 5 in stock

Vérification rapide

Quelle propriété CustomStringConvertible exige-t-il ?

Récapitulatif

Vous avez découvert CustomStringConvertible :

Fournissez var description: String pour produire un texte destiné à l’utilisateur
Cette propriété est utilisée par print, String(describing:) et l’interpolation
Veillez à ce qu’elle reste lisible et légère ; ne cherchez pas à permettre la conversion aller-retour
Elle fonctionne automatiquement dans les collections

Ensuite : CustomDebugStringConvertible.

Questions Fréquemment Posées

La leçon « CustomStringConvertible » est-elle gratuite ?

Oui — le texte complet de « CustomStringConvertible » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Swift Academy, passe à CoddyKit PRO. Le cours Swift Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « CustomStringConvertible » ?

Définissez une description lisible pour vos types. Tu pratiques Swift Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Swift Academy ?

Aucune expérience préalable n'est requise. Swift Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 1 sur 4.

Combien de temps prend la leçon « CustomStringConvertible » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Swift Academy ?

Oui. Chaque leçon Swift Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

← Retour à Swift Academy