Un commento è una parte di testo inserita nel nostro codice che viene ignorata dal compilatore FreeBASIC.
Commentare il proprio codice è necessario, e farlo bene è molto importante.
Perché è necessario commentare il codice?
Nel momento in cui scriviamo una parte magari abbastanza complessa del nostro codice, è molto probabile che il suo funzionamento ci appaia chiaro ed evidente in quanto lo abbiamo concepito e analizzato in maniera approfondita proprio in quei minuti in cui siamo alla tastiera del nostro computer. Che bisogno c’è quindi di inserire un commento?
Il fatto è che, a distanza di tempo, qualora dovessimo rimettere mano a quella parte del codice, quello che ci era così chiaro ed evidente diventa oscuro e intricato. Facciamo fatica a ricordare la logica sottesa a certi passaggi e il perché di certe scelte.
Ecco allora che un commento sintetico è molto di aiuto nel recupero dei ragionamenti che avevamo a suo tempo sviluppato per arrivare alla scrittura di una specifica parte del codice.
Figuriamoci poi se a metterci le mani dovesse essere qualche altro sfortunato programmatore.
Caratteristiche di un buon commento
Come non commentare è sbagliato, così è un errore commentare tutto:
Se un certo passaggio è autoesplicativo, non c’è alcun bisogno di commentarlo.
Commentiamo quindi soltanto quei passaggi che possono presentare una certa complessità o che magari rappresentano dei punti chiave del nostro codice.
Tipi di commento
Il compilatore FreeBASIC riconosce diversi tipi di commento.
Commento su una sola linea
Per scrivere un commento su una sola linea, lo si fa precedere dal simbolo apice (‘):
'Questo è un commento su una sola linea. print "ciao" 'Anche questo è un commento su una sola linea.
oppure al posto dell’apice si può utilizzare la parola rem.
Nota: inserendo un doppio apice ” al posto del singolo apice ‘, si evita che il compilatore FreeBASIC analizzi comunque il commento alla ricerca, per esempio, di qualche meta-comando quale per esempio #include (i meta-comandi possono infatti essere scritti all’interno di un commento). In pratica tutto ciò che segue il doppio apice viene totalmente ignorato dal compilatore.
Commento su più linee
Per scrivere un commento su più linee lo si racchiude tra i simboli /’ … ‘/:
/'Questo è un commento su più linee'/
Nel mondo della Tecnologia dell’Informazione (Information Technology) la lingua franca è l’inglese, è bene quindi che ci sforziamo di scrivere i commenti, i nomi delle variabili e delle funzioni in questa lingua.
A rileggerci al prossimo articolo. 🙂
ciuco informatico 