Les commentaires

Commentaires sur une seule ligne

Ces commentaires commencent par // et couvrent une seule ligne. Ils sont souvent utilisés pour ajouter des annotations brèves ou des explications au sein du code.

// Ceci est un commentaire sur une seule ligne
let name = "John"  // Déclaration d'une constante nommée 'name'

Commentaires sur plusieurs lignes

Les commentaires sur plusieurs lignes commencent par /* et se terminent par */. Ils peuvent s'étendre sur plusieurs lignes, ce qui les rend utiles pour des explications plus longues ou pour désactiver des blocs de code.

/*
 Ceci est un commentaire sur plusieurs lignes.
 Il peut s'étendre sur plusieurs lignes et est souvent utilisé
 pour documenter des sections plus complexes de code.
 */
let age = 25

Commentaires imbriqués

Swift permet d'imbriquer des commentaires sur plusieurs lignes. Cela est particulièrement utile si vous souhaitez désactiver un bloc de code contenant déjà des commentaires sur plusieurs lignes.

/*
 Ce code est désactivé temporairement.
/* Imbrication d'un commentaire sur plusieurs lignes */
let height = 180
*/
let weight = 75  // Ce code sera toujours exécuté

Utilisation des commentaires pour la documentation

Swift permet également de créer des commentaires spécialement formatés pour générer automatiquement de la documentation. Ces commentaires sont utilisés pour documenter des fonctions, des classes, des méthodes, etc.

Commentaires en documentation : Utilisez trois barres obliques (///) pour créer un commentaire de documentation au-dessus d'une fonction, d'une classe ou d'une propriété. Ces commentaires sont reconnus par Xcode et d'autres outils pour générer de la documentation automatique.

/// Cette fonction calcule la somme de deux entiers.
/// - Parameters:
///   - a: Le premier entier.
///   - b: Le deuxième entier.
/// - Returns: La somme de `a` et `b`.
func sum(a: Int, b: Int) -> Int {
    return a + b
}

Commentaires en documentation pour les classes ou structures : Les commentaires peuvent être utilisés pour expliquer à quoi sert une classe, une structure, ou une méthode.

/// Représente un utilisateur dans le système.
/// Cette classe gère les informations personnelles de l'utilisateur
/// et fournit des méthodes pour manipuler ces données.
class User {
    var name: String
    var age: Int

    /// Initialise un nouvel utilisateur avec un nom et un âge.
    /// - Parameters:
    ///   - name: Le nom de l'utilisateur.
    ///   - age: L'âge de l'utilisateur.
    init(name: String, age: Int) {
        self.name = name
        self.age = age
    }

    /// Retourne une description complète de l'utilisateur.
    func description() -> String {
        return "\(name), \(age) ans"
    }
}

Bonnes pratiques pour les commentaires

• Soyez concis et pertinent : Les commentaires doivent clarifier le code sans être redondants. Expliquez pourquoi quelque chose est fait plutôt que ce qui est fait.
• Mettez à jour les commentaires avec le code : Si vous modifiez le code, assurez-vous que les commentaires restent pertinents.
• Utilisez la documentation automatique : Profitez des commentaires de documentation pour générer des descriptions utiles.

Points Clés à Retenir

• Commentaires sur une seule ligne (//) pour les annotations courtes.
• Commentaires sur plusieurs lignes (/* ... */) pour les explications longues ou désactiver du code.
• Commentaires imbriqués pour désactiver des blocs complexes.
• Commentaires de documentation (///) pour générer automatiquement de la documentation détaillée.