Sviluppare una soluzione in FileMaker: il potere dei commenti
Introduzione
Nella rubrica Point Break stiamo valutando l’importanza di adottare un metodo di sviluppo e quali sono le regole fondamentali per creare un metodo di sviluppo personalizzato in FileMaker che ci accompagni nel corso della nostra professione. Nel precedente articolo abbiamo risposto alla domanda:  Vale la pena perdere un po’ di tempo nella fase iniziale per facilitarci il compito in quelle successive?Â
Oggi focalizziamo l’attenzione sui commenti negli script e su quanto sia importante non sottovalutarli. Vi spiegheremo una tecnica per poter mettere a frutto i commenti a partire dalla fase di sviluppo del software.
Commentare è meglio che decifrare
Capita spesso che, per effettuare una modifica o per corrregere un bug, ci si trovi costretti a dover decifrare uno o più script.
Il termine decifrare non è utilizzato a caso, perchè il rischio è quello di trovarsi di fronte ad una serie di istruzioni che, pur essendo state compilate da noi, risultano totalmente illeggibili. Perchè? Semplicemente perchè non sono commentate.
Il punto è che uno script senza commenti, nel momento in cui lo scrivete, vi apparirà chiaro e lineare, ma in un futuro nemmeno troppo lontano potrebbe nascondere delle incognite che vi costringeranno a perdere un sacco di tempo e di energie per capire cosa avevate in testa quel giorno in cui siete stati magari molto creativi, ma sicuramente un po’ troppo frettolosi.
Come viene azionato? Parte premendo un pulsante? Viene richiamato come subscript da un altro script? È una procedura eseguita dal server? Ma soprattutto, a cosa serve?
Quando abbiamo costruito l’applicazione, immersi nel lavoro, concentrati su quanto stavamo facendo, le cose ci sono sembrate semplici, così facili che abbiamo reputato una perdita di tempo il dovere inserire dei commenti che ci apparivano scontati.
Verifico l’esattezza di questo dato, mi sposto a quel layout per eseguire un certo calcolo, faccio un loop sulle righe di questa tabella per riassegnare un certo valore. Si vede tutto chiaramente semplicemente leggendo le istruzioni di script, perché dovrei perdere tempo a scriverlo nei commenti?
Quando dopo molto tempo ci ritroviamo davanti ad un software che non vedevamo da anni quello script tanto chiaro e lineare ci sembra scritto in aramaico. E lì, in quel preciso istante, scorrendo le righe di script ci chiediamo perché non abbiamo inserito almeno un commento.
È cosa nota e universalmente riconosciuta che, nonostante i miei sforzi per convincervi, una faccenda posta in questi termini (fai una certa cosa oggi per averne dei benefici in un domani che potrebbe anche non arrivare mai) facilmente sembrerà un’inutile rottura di scatole.
Un po’ come quei consigli che ci inseguivano da bambini e che erano destinati a rimanere inascoltati. Non correre con le stringhe slacciate che rischi di cadere e farti male, copriti se fa freddo altrimenti ti ammali, metti i commenti negli script se no quando li dovrai rileggere ti verrà mal di testa.
Una vera noia.
Il consiglio
Ribalta la situazione a tuo favore. Come? Semplice: inseriamo i commenti prima di scrivere le istruzioni di script.
Perchè proprio qui sta il trucco: scrivere i commenti prima dello script ci aiuta a trovare la logica giusta per compiere una determinata azione, ed in più ci da il vantaggio enorme di trovarci uno script perfettamente commentato.
Vediamo un esempio pratico, grazie ad uno script che serve a creare un report dei pagamenti scaduti e in scadenza dei clienti di un’azienda.
Un esempio pratico
Nell’immagine che segue possiamo vedere come apparirebbe lo script senza commenti.
Pur essendo composto da un numero limitato di istruzioni, ricostruirne la logica non è un processo immediato.
Ripartiamo dal principio: nell’immagine successiva vediamo come sarebbe dovuto nascere lo script.
I commenti servono a descrivere le azioni che dovranno essere compiute dallo script stesso. Questa è la fase più importante di creazione di una procedura, perchè è a questo livello che si risolvono i problemi di logica che verranno poi tradotti in linguaggio tecnico attraverso le istruzioni vere e proprie.
La prossima immagine mostra il risultato finale dello script perfettamente commentato, costruito inframmezzando le istruzioni alle righe di commento.
Conclusione
In questo articolo abbiamo quindi cercato di farvi comprendere quanto sia importante avere degli script commentati, e come possa essere utile la tecnica di scrivere i commenti per usarli come traccia per la compilazione dello script stesso.
Continueremo a parlare di metodo di programmazione in FileMaker anche nel prossimo articolo di Point Break, questa volta concentrando la nostra attenzione sui campi, sui più comuni standard di nomenclatura e su come evitare di costruire calcoli incomprensibili.
Nel frattempo toglietemi una curiosità : utilizzate i commenti nei vostri script?
