Description de la leçon
Commentaires
4m 4s
Utilisez l'outil de commentaires pour laisser des notes d'organisation et d'instructions dans votre script Lua ou votre Block Controller.
Transcription Vidéo
Commentaires
4m 4s
0:08
Commençons nos leçons de script en douceur par les commentaires. Quand on débute en écriture de
0:13
code, on s’aperçoit souvent qu'on aimerait laisser des remarques dans ce code. On les appelle des
0:17
commentaires, et vous pouvez en laisser de toutes sortes. Ils peuvent concerner vos propres besoins
0:23
d’organisation en sections, ou servir à inclure des instructions pour ceux qui pourraient devoir regarder
0:28
votre code. Ces commentaires… HEY ! D’autres types de commentaires, revenez ici. Un commentaire
0:37
dans le code peut être défini comme une information réservée à l'œil humain qui doit être ignorée par
0:43
le compilateur. Fondamentalement, cela n'a aucun effet sur le script.
0:48
Regardons d'abord Lua. Pour créer un commentaire, tapez simplement deux tirets. Tout ce qui suit sera
0:55
considéré comme un commentaire, et deviendra vert pour l’indiquer. Ce commentaire est appelé ligne
1:01
de commentaire car il se limite à la ligne sur laquelle vous vous trouvez. Lorsque vous passez à la ligne
1:07
de code suivante, le script redevient gris.
1:10
Pour ajouter plusieurs lignes de commentaires, vous pouvez saisir un autre double tiret, ou utiliser un
1:14
commentaire « multiligne ». Pour cela, vous pouvez ajouter deux tirets, puis deux crochets ouvrants.
1:24
Tout ce qui suit sera considéré comme du commentaire, sur autant de lignes de code que vous le
1:28
souhaitez, jusqu'à ce que vous y mettiez fin par deux crochets fermants suivis de deux autres tirets.
1:33
Il y a un léger souci avec l'utilisation de ce commentaire multiligne – et si vous devez inclure deux
1:38
crochets fermants dans votre commentaire ? Vous ne voudriez pas que cette inclusion dans le texte
1:42
mette prématurément fin au commentaire.
1:47
Dans ce cas, vous pouvez modifier les doubles crochets utilisés pour débuter votre commentaire en
1:51
ajoutant un signe égal entre eux, ce qui change le type des balises que vous utilisez pour délimiter votre
1:56
commentaire. Vous vous servirez du même symbole pour fermer plus loin le commentaire multiligne.
2:04
Vous pouvez utiliser ce principe avec un double ou triple signe égal s’il vous faut des niveaux
2:08
supplémentaires de balises uniques. Cela peut sembler extrême pour quelque chose d'aussi simple que
2:14
des commentaires, mais le savoir dès maintenant servira plus dans d'autres façons de manipuler des
2:18
chaînes de caractères. Mais en général, le simple double tiret traditionnel ou la balise de commentaire
2:25
multiligne suffiront.
2:28
En ce qui concerne le Block Controller, vous pouvez ajouter un commentaire en allant dans la catégorie
2:32
Système et en ajoutant ce bloc ici. Son intitulé signifie « Un commentaire pour ce bloc », et vous pouvez
2:39
y saisir votre commentaire.
2:41
Sinon, vous pouvez insérer un commentaire directement dans la plupart des blocs en cliquant dessus
2:46
avec le bouton droit et en affichant un commentaire avec « Show Comment ». Cela insère en haut un
2:51
bloc Commentaire utilisable pour le titrage, des instructions, etc.
2:56
Et si vous allez dans l'onglet Lua, vous pouvez voir que ce commentaire a été créé avec le double tiret
3:01
que nous venons d'apprendre, ou même avec la version à double crochet pour le bloc de commentaire.
3:09
Ces commentaires peuvent ne pas apparaître en vert sur cet écran, mais n'oubliez pas que cette page de
3:13
script blanche ne peut pas être modifiée. Si vous convertissiez vos blocs en écran de script modifiable,
3:20
vous verriez ces commentaires en vert.
3:24
Si vous voulez ajouter des commentaires à vos Composants de contrôle, c'est aussi simple que d'ajouter
3:28
des étiquettes ! Avec les outils graphiques, vous pouvez ajouter un bloc de texte, un en-tête ou un cadre
3:34
de regroupement, autant de façons d'étiqueter votre projet ou de donner des instructions à celui qui l’étudie.
3:43
Vous pouvez également renommer n'importe lequel de vos Composants de contrôle rien qu’en le
3:47
sélectionnant et en tapant un nouveau nom, un bon moyen de décrire sa fonction – ce qui revient à
3:52
laisser un commentaire.
3:55
Allez-y et suivez une courte leçon sur les commentaires dans le Cahier d'exercices Q-SYS Contrôle, puis
4:00
passez à la vidéo suivante.
Téléchargements et liens
Commentaires
4m 4s