Sur une ligne

Sur plusieurs lignes

En section

Documentation

Commentaire

Les Leçons

Commentaire

Il y a une petite notion que j’ai oublié de te présenter depuis le début de ce programme 🫣, et pourtant, tu l’as déjà vue passer, ce sont les commentaires.

Les commentaires sont utilisés pour ajouter des annotations ou des notes explicatives dans le code, que ce soit pour soi-même ou pour d’autres développeurs. Ils sont ignorés par le compilateur, donc n’ont aucun impact sur l’exécution du programme.

 Commentaires sur une ligne

Pour mettre en commentaire une ligne de code, il suffit de placer // en début de celle-ci. Par exemple :


// Ceci est un commentaire sur une ligne

 Commentaires sur plusieurs lignes

Pour mettre en commentaire plusieurs lignes de code, on utilise /* en début de la première ligne et */ en fin de la dernière ligne. Par exemple :


/*
Ceci est un commentaire sur
plusieurs lignes
*/

Dans cet exemple, si score est 85, « Très bien » sera affiché à l’utilisateur. Swift évalue chaque condition de haut en bas et exécute le bloc de code associé à la première condition vraie. Si score avait été 45, « Vous pouvez mieux faire » aurait été affiché, car aucune des autres conditions n’aurait été vraie, conduisant l’exécution au bloc else.

 Sections de commentaires

Il est possible de créer des sections de commentaires avec le format // MARK: – Nom de la section. Ça permet de mieux organiser son code. On peut également utiliser //TODO ou // FIXME pour respectivement marquer une tache à faire ou un bug à fixer.


// MARK: - Fonctions de gestion de la base de données

func saveData() {
    // Code pour sauvegarder les données
}

func loadData() {
    // Code pour charger les données
}

Commentaire de documentation

Les commentaires de documentation, également appelés « Doc-Comments« , commencent par /// pour un seul élément ou /** … */ pour plusieurs éléments. Ils permettent de générer automatiquement une documentation.


/**
 Fonction pour soustraire deux nombres entiers.
 - Parameters:
   - a: Premier nombre entier
   - b: Deuxième nombre entier
 - Returns: La différence entre `a` et `b`
*/
func soustraire(_ a: Int, _ b: Int) -> Int {
    return a - b
}
Boucle while
Fonction

Pas de pratique cette fois !

Note

Les commentaires sont là pour t’aider à expliquer ton code ou à le rendre plus lisible. Utilise-les avec modération : un code clair et bien structuré a souvent besoin de peu de commentaires.

Pas de pratique cette fois !

Note

Les commentaires sont là pour t’aider à expliquer ton code ou à le rendre plus lisible. Utilise-les avec modération : un code clair et bien structuré a souvent besoin de peu de commentaires.