Style de commentaires AutoLISP

Publié par Maxence le mar, 29/12/2015 - 18:03

C'est quelque chose qui est mal connu, mais en AutoLISP, il y a plusieurs styles de commentaire qui sont traités différemment par la commande de formatage de l'éditeur Visual LISP. Un commentaire débutant avec un seul point virgule par exemple, c'est pour commenter une ligne de code particulière. Par exemple :

(setq a (1+ a))                                           ; Ajoute 1 à la variable a

Le commentaire est placé à droite et commence à une colonne qu'on peut définir dans les options de l'éditeur (Outils, Options d'environnement, Options de formatage VisualLISP, Mise en retrait de commentaire avec point virgule unique).

Si on veut commenter une section du code, on va utiliser deux points-virgules :

(defun draw-entities (x)
  ;; Vérifie les données d'entrée
  (if (/= (type x) 'REAL) ...
  ;; Dessine les entités
  (command "_LINE" ...
)

Le commentaire est aligné avec la ligne qui suit.

Si on veut un commentaire commençant à la première colonne, on utilise 3 points virgules :

;;; Charge la configuration
;;; Arguments :
;;;   filename string Nom du fichier de configuration
(defun load-config (filename)
  ...

On peut utiliser ce style pour les entêtes de fonction. L'éditeur Visual LISP utilise ce style pour mettre en commentaire les lignes sélectionnés quand on utilise l'outil Mettre le bloc en commentaire.

Il y a également le style de commentaire pour les parenthèses fermantes :

) ;_ Fin de while

C'est utile quand vous avez un très grand bloc de code, pour vous retrouver dans les parenthèses fermantes. En général c'est à éviter car si vous avez un grand bloc de code, c'est que vous créez des fonctions trop longues (une fonction ne doit pas dépasser 15 à 20 lignes, sauf exception comme un très grand bloc cond). Notez que l'éditeur Visual LISP peut insérer automatiquement ce genre de commentaire (Outils, Options d'environnement, Options de formatage VisualLISP, Insérer commentaire de fin).

Enfin il y a les commentaires sur plusieurs lignes :

;| Ce commentaire
   s'étend sur
   plusieurs lignes |;

Ces différents styles sont détaillés dans la documentation

Etiquettes:

Ajouter un commentaire