Contenu du cours
Introduction à TypeScript
Introduction à TypeScript
Commentaires
Q: Que fait un programmeur lorsqu'il doit rédiger la documentation de son code ?
A: Il l'écrit dans un fichier Word.
Q: Que fait un bon programmeur lorsqu'il doit rédiger la documentation de son code ?
A: Il utilise des commentaires.
Transformons-vous en bon programmeur et apprenons également à utiliser les commentaires dans votre code. Mais d'abord, découvrons ce qu'ils sont :
En TypeScript, il existe deux types de commentaires :
- Nous pouvons commenter une ligne entière en utilisant
//
; - Nous pouvons également commenter un bloc de code s'étendant sur plusieurs lignes ou un fragment de code sur une seule ligne en utilisant
/* code */
.
Voyons un exemple où nous devons commenter certaines lignes et y écrire des commentaires. Je le répète, le compilateur n'exécutera pas et ne regardera même pas les fragments de code commentés, donc nous pouvons y écrire n'importe quoi (sauf des gros mots ; ma mère me gronde si j'écris ça).
console.log("Hello world!") // This code performs output of information to the screen. let word : string = 'c<>definity' console.log(`Hello ${word}!`) /*This code creates a variable of type string and uses it for output to the screen. We use this variable with the required syntax and successfully display text on the screen with the variable. */
Comme vous pouvez le voir dans le code ci-dessus, nous avons commenté divers fragments de texte. Dans les commentaires, nous écrivons des explications sur ce qui se passe dans le code et ce que font certaines lignes. Remarquez que lorsque nous commentons plusieurs lignes, nous utilisons une syntaxe de commentaire différente. (/* */
)
Après //
, tout ce qui se trouve à droite des caractères est commenté.
Nous pouvons également commenter des fragments de code. Par exemple, si nous soupçonnons une erreur dans une ligne particulière, nous pouvons commenter cette ligne et exécuter à nouveau le code pour vérifier cette ligne pour des erreurs.
//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Ci-dessus, nous avons commenté des fragments de code dans lesquels nous soupçonnons des erreurs en utilisant différents types de commentaires. Personnellement, j'identifie souvent les zones sujettes aux erreurs dans le code en utilisant cette méthode, et je vous recommande de faire de même. C'est une compétence utile pour un bon programmeur.
De plus, n'oubliez pas d'écrire de la documentation pour votre code. C'est comme placer une bouteille d'eau à côté de votre lit après une nuit de beuverie.
Merci pour vos commentaires !