Dans cet article, vous découvrirez les commentaires Swift, pourquoi et comment les utiliser.
Un commentaire est une explication ou une annotation lisible par le programmeur dans le code source d'un programme. Il est ignoré par le compilateur lorsque le code est compilé.
Les commentaires sont destinés à la personne lisant le code pour mieux comprendre l'intention et la fonctionnalité du programme. Il peut être utile, tout en travaillant en équipe, de clarifier l'objectif du code pour les autres membres de l'équipe ou tout en travaillant uniquement, il peut servir de rappel de propriété.
Commentaire Swift et ses types
Dans Swift, il existe deux types de commentaires:
1. Commentaire sur une seule ligne
Dans Swift, toute ligne commençant par deux barres obliques //est un commentaire sur une seule ligne. Tout ce qui commence par deux barres obliques //est ignoré par le compilateur.
Vous pouvez trouver un exemple simple en haut de l'aire de jeux:
//: Playground - nom: un endroit où les gens peuvent jouer
Il commence par deux barres obliques //et fournit une explication significative du fichier comme ": Playground - nom: un endroit où les gens peuvent jouer".
Exemple 1: Commentaire sur une seule ligne
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
L'exemple ci-dessus contient deux commentaires sur une seule ligne:
// Exemple de programme // stocke 3.14 dans la variable pi
2. Commentaire multiligne
Si votre commentaire comprend plusieurs lignes, vous pouvez le mettre à l'intérieur /*… */.
Les commentaires multilignes commencent par une barre oblique suivie d'un astérisque ( /*) et se terminent par un astérisque suivi d'une barre oblique ( */). Tout entre /*et */est ignoré par le compilateur rapide.
/ * Ceci est un commentaire multiligne. Après avoir écrit un commentaire multiligne, ajoutez * suivi de / pour le terminer * /
Exemple 2: commentaire multiligne
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
L'exemple ci-dessus contient un commentaire multiligne.
/ * La valeur pi codée en dur peut être moins précise. Ainsi, vous pouvez calculer en utilisant des types de données intégrés pour une valeur plus précise * /
Choses dont il faut se rappeler
Bien que les commentaires soient utiles pour mieux comprendre l'intention du code écrit. Voici ce que vous devez prendre en compte lors de sa rédaction:
- Ne placez pas les commentaires avec // sur la multiligne bien qu'il soit valide et que le compilateur ignore ces lignes. Au lieu de cela, placez-le dans un commentaire multiligne
/*… */
Exemple:// Ceci est un commentaire. // Utilisez-le si nécessaire et avec précision
La méthode ci-dessus pour écrire un commentaire est correcte mais non recommandée car vous devez écrire des commentaires sur plusieurs lignes si le commentaire est supérieur à une ligne. La meilleure façon d'écrire consiste à utiliser un commentaire multiligne comme:/ * Ceci est un commentaire. Utilisez-le si nécessaire et précisément * /
- Un commentaire sur une seule ligne peut être écrit sur une ligne distincte ou avec du code sur la même ligne. Cependant, il est recommandé d'utiliser les commentaires sur une ligne distincte.
Exemple:let pi = 3.14159 // stocke 3.14 dans la variable pi
Cette façon d'écrire des commentaires est valide. Mais il est préférable d'écrire un commentaire sur une ligne séparée comme:// stocke 3,14 dans la variable pi soit pi = 3,14159
- Même si vous êtes un seul développeur dans une équipe et que vous êtes le seul à écrire le code, s'il n'est pas commenté, vous aurez du mal à essayer de comprendre son objectif dans le programme. Alors, utilisez-le avec précision et fournissez une description significative.
- Faites un commentaire très simple et significatif.
- N'écrivez pas de commentaires inutiles sur votre code.
- Dans la plupart des cas, utilisez des commentaires pour expliquer «pourquoi» plutôt que «comment».
