Lisp »Tips 'n Tricks »Indentazione e commenti

Un commento è semplicemente una nota che spiega il programma nei punti salienti.

E' bene inserire dei commenti all'interno del codice dei nostri programmi sia per chi leggerà il sorgente sia per noi stessi, quando ci torneremo sopra, magari dopo una settimana.
Un commento in AutoLISP inizia con il simbolo ; ad esempio:

;questo è un commento...
; anche questo è un commento...

	;          e anche questo

E' possibile inserire più righe di commento facendo precedere ogni rigo dal simbolo ; così:

; Qui inizia il commento
; secondo rigo
; terzo rigo
; ...
; n rigo

Oppure iniziare il commento con il simbolo ;| e chiuderlo con il simbolo |; ad esempio:

;| Qui inizia il commento.
   Qui puoi aggiungere quante righe vuoi al commento.
   Qui termina il commento |;

Premesso che alla base di un sorgente leggibile c'è un buon algoritmo, per rendere il più possibile chiaro e leggibile un sorgente non basta inserire commenti a pioggia più o meno superflui, ma è bene indentare il nostro codice.
Un sorgente con una buona indentazione necessita di meno commenti superflui.

L'interprete AutoLISP non bada all'indentazione del nostro sorgente, cioè per lui i seguenti codici sono uguali:

(defun myerror (s)                  
  (if (/= s "Function cancelled")
    (princ (strcat "\nError: " s))
  )
 (ripVar)
 (princ)
)

(defun myerror (s)
(if (/= s "Function cancelled")
(princ (strcat "\nError: " s))
);end if
(ripVar)
(princ)
);end defun

(defun myerror (s) (if (/= s "Function cancelled") (princ (strcat "\nError: " s)) ) (ripVar) (princ) )

Ma l'interprete AutoLISP non è un essere umano.

Lisp »Tips 'n Tricks