Commentaires Swift

Dans cet article, vous découvrirez les commentaires Swift, pourquoi et comment les utiliser.

Les commentaires sont des explications ou des annotations lisibles par l'homme dans le code source du programme. Lors de la compilation du code, le compilateur les ignore.

Les commentaires sont là pour aider les lecteurs de code à mieux comprendre l'intention et la fonction du programme. Lorsqu'ils travaillent en équipe, ils peuvent être très utiles pour clarifier l'objectif du code pour d'autres membres de l'équipe, ou pour se rappeler leur propre objectif en travaillant seul.

Commentaires Swift et leurs types

Swift a deux types de commentaires :

1.commentaires en une ligne

Dans Swift, toute ligne commençant par // Les lignes commençant par // Les lignes commençant par

Vous pouvez trouver un exemple simple en haut du playground :

//: Playground　-　nom: un endroit où les gens peuvent jouer

commence par deux barres obliques // commence par et fournit une explication significative au fichier, par exemple : "Playground" - nom: un endroit où les gens peuvent jouer

Exemple1：commentaires en une ligne

//Programme d'exemple
//stocke　3.14　in variable pi
let pi =　3.14159　
print(pi)

L'exemple ci-dessus contient deux commentaires en une ligne :

//　Programme d'exemple
//　stocke　3.14　in variable pi

2.commentaires multilignes

Si vos commentaires contiennent plusieurs lignes, vous pouvez les encadrer/*...*/.

Les commentaires multilignes commencent par une barre oblique (//*) terminé par une étoile, suivi d'une barre oblique (/*/) Le compilateur Swift ignore/* et */Toutes les informations entre

/*　C'est un commentaire multiligne.
Ajoutez après avoir écrit un commentaire multiligne*, suivi de/pour le terminer
*/

Exemple2：commentaires multilignes

/*　La valeur codée en dur de pi peut ne pas être aussi précise.
Ainsi, vous pouvez utiliser les types de données intégrés pour calculer des valeurs plus précises.
*/
let pi = Double.pi
print(pi)

L'exemple ci-dessus contient un commentaire multiligne.

/*　La valeur codée en dur de pi peut ne pas être aussi précise.
Ainsi, vous pouvez utiliser les types de données intégrés pour calculer des valeurs plus précises.
*/

Les choses à retenir

Bien que les commentaires soient très utiles pour mieux comprendre l'intention du code écrit, il est important de noter que :

1. Ne pas inclure de commentaires dans une multiligne.//Bien que cela soit efficace, le compilateur ignore ces lignes. Au lieu de cela, il devrait être placé dans un commentaire multiligne./* ... */中
   Par exemple :

   //Ceci est un commentaire.
   //Utilisez-le lorsque nécessaire et précisément

   La méthode d'écriture des commentaires ci-dessus est correcte, mais il n'est pas recommandé de le faire, car si les commentaires dépassent une ligne, il faut écrire des commentaires sur plusieurs lignes. Une meilleure méthode d'écriture est d'utiliser les commentaires sur plusieurs lignes comme :

   /*　Ceci est un commentaire.
   Utilisez-le lorsque nécessaire et précisément
   */

2. Les commentaires en une ligne peuvent être écrits sur une ligne séparée ou avec le code sur la même ligne. Cependant, il est recommandé d'utiliser des lignes séparées pour les commentaires.
   Par exemple :

   let pi =　3.14159　//stocke　3.14　in variable pi

   Cette méthode de commentaires est efficace. Cependant, il est préférable d'écrire les commentaires sur une ligne séparée:
   

   //stocke　3.14　in variable pi
   let pi =　3.14159

3. Même si vous êtes le seul développeur dans une équipe et que vous êtes le seul à écrire du code, il est difficile de trouver l'utilisation du code sans commentaires. Alors, utilisez-le précisément et fournissez une description significative.

4. Rendez les commentaires très simples et significatifs.

5. Ne pas écrire de commentaires inutiles sur le code.

6. Dans la plupart des cas, utilisez des commentaires pour expliquer 'pourquoi' plutôt que 'comment'.