Commentaires
Q : Que fait un programmeur lorsqu'il doit rédiger la documentation de son code ?
R : Il la rédige dans un fichier Word.
Q : Que fait un bon programmeur lorsqu'il doit rédiger la documentation de son code ?
R : Il utilise des commentaires.
Apprenons à devenir un bon programmeur et découvrons comment utiliser les commentaires dans votre code. Mais d'abord, voyons ce que sont les commentaires :
En TypeScript, il existe deux types de commentaires :
- Il est possible de commenter une ligne entière à l'aide de
//; - Il est également possible de commenter un bloc de code sur plusieurs lignes ou un fragment de code sur une seule ligne à l'aide de
/* code */.
Voici un exemple où il est nécessaire de commenter certaines lignes et d'y écrire des commentaires. Je le répète, le compilateur n'exécutera pas et ne prendra même pas en compte les fragments de code commentés, il est donc possible d'y écrire n'importe quoi (sauf des gros mots ; ma mère me gronde si j'en écris).
12345678console.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, divers fragments de texte ont été mis en commentaire. Dans les commentaires, des explications sur le déroulement du code et la fonction de certaines lignes sont fournies. Remarquez que pour commenter plusieurs lignes, une syntaxe différente est utilisée. (/* */)
Après //, tout ce qui se trouve à droite de ces caractères est mis en commentaire.
Il est également possible de commenter des fragments de code. Par exemple, en cas de suspicion d’erreur sur une ligne particulière, il est possible de commenter cette ligne et d’exécuter à nouveau le code afin de vérifier la présence d’erreurs sur cette ligne.
123//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Ci-dessus, des fragments de code dans lesquels des erreurs sont suspectées ont été mis en commentaire à l’aide de différents types de commentaires. Personnellement, j’identifie souvent les zones susceptibles de contenir des erreurs dans le code en utilisant cette méthode, et il est recommandé de faire de même. Il s’agit d’une compétence utile pour tout bon programmeur.
De plus, il ne faut pas oublier de rédiger la documentation de votre code. C’est comparable à placer une bouteille d’eau à côté de votre lit après une nuit de fête.
Merci pour vos commentaires !
Demandez à l'IA
Demandez à l'IA
Posez n'importe quelle question ou essayez l'une des questions suggérées pour commencer notre discussion
Awesome!
Completion rate improved to 2.94Commentaires
Glissez pour afficher le menu
Q : Que fait un programmeur lorsqu'il doit rédiger la documentation de son code ?
R : Il la rédige dans un fichier Word.
Q : Que fait un bon programmeur lorsqu'il doit rédiger la documentation de son code ?
R : Il utilise des commentaires.
Apprenons à devenir un bon programmeur et découvrons comment utiliser les commentaires dans votre code. Mais d'abord, voyons ce que sont les commentaires :
En TypeScript, il existe deux types de commentaires :
- Il est possible de commenter une ligne entière à l'aide de
//; - Il est également possible de commenter un bloc de code sur plusieurs lignes ou un fragment de code sur une seule ligne à l'aide de
/* code */.
Voici un exemple où il est nécessaire de commenter certaines lignes et d'y écrire des commentaires. Je le répète, le compilateur n'exécutera pas et ne prendra même pas en compte les fragments de code commentés, il est donc possible d'y écrire n'importe quoi (sauf des gros mots ; ma mère me gronde si j'en écris).
12345678console.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, divers fragments de texte ont été mis en commentaire. Dans les commentaires, des explications sur le déroulement du code et la fonction de certaines lignes sont fournies. Remarquez que pour commenter plusieurs lignes, une syntaxe différente est utilisée. (/* */)
Après //, tout ce qui se trouve à droite de ces caractères est mis en commentaire.
Il est également possible de commenter des fragments de code. Par exemple, en cas de suspicion d’erreur sur une ligne particulière, il est possible de commenter cette ligne et d’exécuter à nouveau le code afin de vérifier la présence d’erreurs sur cette ligne.
123//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Ci-dessus, des fragments de code dans lesquels des erreurs sont suspectées ont été mis en commentaire à l’aide de différents types de commentaires. Personnellement, j’identifie souvent les zones susceptibles de contenir des erreurs dans le code en utilisant cette méthode, et il est recommandé de faire de même. Il s’agit d’une compétence utile pour tout bon programmeur.
De plus, il ne faut pas oublier de rédiger la documentation de votre code. C’est comparable à placer une bouteille d’eau à côté de votre lit après une nuit de fête.
Merci pour vos commentaires !
