Esercizio# 3 - Commentiamo il codice - Output.spin 

In questo esercizio verrà illustrato come poter inserire nel codice alcuni commenti utili al lettore, al fine di rendere il programma maggiormente leggibile. I commenti sono importanti perché possono descrivere con maggiore dettagli lo scopo del programma e come potrebbe essere modificato e migliorato anche da chi non lo ha sviluppato. Nel linguaggio SPIN ci sono diversi modi per aggiungere commenti. Questi rimangono solo nel codice sorgente e in fase di compilazione vengono ignorati.
 

Un commento può essere inserito affianco ad una riga di codice eseguibile, oppure interamente in una o più righe del file. Il blocco dei commenti deve sempre iniziare con uno dei caratteri speciali dedicati a questa funzione, ed a seconda del tipo impiegato, deve finire con il rispettivo carattere di fine blocco.

Ecco i quattro tipi:
 

'....	Singola linea di commento
''....	Singola linea documento di commento
{....}	Inizio e fine commento del codice
{{.....}}	Inizio e fine documento di commento

Le singole linee di commento possono essere utilizzate solo sulla linea di testo dove vengono usate. Il codice eseguibile in questo caso si deve trovare necessariamente alla sinistra dell'inizio del commento (altrimenti sarebbe anch'esso un commento e quindi non verrebbe eseguito). I speciali caratteri da utilizzare per i 'documenti di commento' si possono utilizzare per avere una speciale funzione dell'ambiente IDE del propeller. Per ciascun file aperto dall'IDE, in alto alla finestra è disponibile l'opzione 'Documentation' che effettua l'estrapolazione di solo le parti di testo contenute all'interno di questi speciali blocchi di commento.