COMMENTAIRES

 

Les commentaires sont bien plus qu'une bonne habitude, et qui plus est une bonne habitude à prendre dès le début de votre apprentissage de la programmation, ils sont vraiment utiles.

Même étant l'auteur du programme il est courant de se perdre dans les lignes de code, le pire se présente quand on passe derrière quelqu'un pour compléter un programme comme c'est souvent le cas avec l'internet qui propose des milliers de programmes de base ou des demandes de corrections.

Que ce soit le nom des variables ou ce qu'on attend comme forme de données (list, string, integer...) il est aisé de les commenter à la création et c'est tellement plus simple à reprendre même par soi-même quelques mois plus tard, voire des années sans avoir à se dire : qu'est-ce que j'ai bien voulu faire dans ce code ?.


Commentaire simple :
Une ligne commençant par un point-virgule est considérée comme commentaire,
c’est-à-dire :
TOUT ce qui suit le (ou les) point(s)-virgule(s) ne sera pas interprété par le programme.
Pour être plus précis TOUT ce qui suit mais jusqu'à la fin de la ligne car un retour à la ligne stoppe le commentaire
On s'en sert pour expliquer le nom d'une variable ou bien l'action spécifique d'une ligne de code, ou encore pour expliquer une limitation du programme.

Exemple de code sans aucun commentaire d'aucune sorte :

commentaires_01

Le même code mais avec des lignes de commentaires bien placés :
c'est autrement plus clair, non ? qu'en pensez-vous ?

image non trouvée

Le commentaire supporte d'être sur la même ligne que le code, c'est aussi clair et ne nuit aucunement à l'exécution du code :

commentaires_03


Commentaire sur lignes multiples :
Un commentaire sur plusieurs lignes commence par un point-virgule suivi d'un trait vertical (combinaison de touches AltGr+ 6), ce genre de commentaire est souvent utilisé en début de code pour expliquer ce qu'il contient et c'est assez pratique pour ceux qui lisent le code, on peut éventuellement y mettre un exemple de syntaxe :


Mettre en commentaire par l'IDE :

commentaires_05
Deux icônes : celle de gauche c'est pour mettre en commentaire le texte surligné, à droite c'est pour retirer le commentaire, notez que ça ne retire pas ce qui est écrit ça retire le formatage du commentaire

En surlignant une partie du code puis en cliquant sur l'icône de gauche :
la totalité du texte sélectionné passera en commentaire.
Une ligne de code peut aussi être mise en commentaire de cette façon, cela peut-être utile pour copier deux fois cette ligne de code, passer la première en commentaire, travailler dans la deuxième en gardant l'original sous les yeux, et revenir à la première en cas d'échec.

En surlignant une partie du code puis en cliquant sur l'icône de droite :
le texte sélectionné perd son formatage "commentaire".

Si on sélectionne plusieurs lignes de code et qu'on utilise les icônes citées le commentaire ne sera pas formaté en lignes multiples comme précisé plus haut mais trois "point-virgule" seront ajoutés au début de chaque ligne :
commentaires_06

Pour débuter avec les commentaires il me semble que ces quelques indications seront suffisantes, mais je me permets d'insister pour que vous preniez l'habitude de déposer des commentaires dans les codes, c'est tellement plus simple !.

Le nombre de "points-virgules" devant la ligne de commentaire définit le formatage du code dans l'éditeur Visual LISP® et placera différemment la ligne de commentaire :

1 ; le commentaire se place en retrait à droite à 40 caractères (défaut)
2 ;; le commentaire prend le retrait du code à sa position
3 ;;;
le commentaire est placé complètement à gauche
;_ commentaire de fin, se place à une espace de la dernière parenthèse.

Au fur et à mesure de vos progrès j'ai confiance en votre curiosité et vous irez de vous-même farfouiller parmi les dizaines d'options dont fourmille cet I.D.E.


Haut de page

continuer vers AUTO-COMPLÉTION

Retour au menu ENVIRONNEMENT


22 juin 2017