Un elemento che deve essere curato con attenzione, mentre si scrive software, è l’assegnazione del nome delle variabili utilizzate. Può sembrare una cosa banale ma un’applicazione complessa richiede centinaia o migliaia di variabili; procedere in modo disordinato nell’assegnare dei nomi può rendere intricata la comprensione di quanto scritto. Personalmente mi sono dato una serie di regole alle quali mi attengo, indipendentemente dalla consistenza dell’applicazione; ve le illustro a titolo di esempio.

Leggendo il nome della variabile deve risultare chiaro quale è l’informazione che vi è contenuta, per cui tendo a non lesinare sulla sua lunghezza. Di solito un singolo termine non è sufficiente per dare una definizione, ne possono servire da due a quattro, i termini si possono concatenare in modo da creare una parola unica, anche usando abbreviazioni. L’accortezza di mantenere la prima lettera di ogni parola maiuscole rende i singoli termini ben visibili. Questa tecnica prende il nome di “Pascal Case”. Per esempio: la posizione attuale di un mandrino potrebbe essere contenuto nella variabile PosizioneAttMandrino, oppure la coordinata verticale del centro di un detettore potrebbe diventare: CooZCentroDetettore.

Inoltre, evito di utilizzare il carattere underscore che appesantisce la lettura e tendo ad avere almeno tre caratteri per ogni termine che compone il nome della variabile. Unica eccezione sono le variabili utilizzate come indice per accedere ad array. In questo caso uso variabili anche con una singola lettera: i, j, x, y, z.

Utilizzando CODESYS la lunghezza dei nomi non è un problema. L’editor dispone della funzionalità intellisense: una volta scritto il nome parziale di una variabile con CTRL + barra spaziatrice si richiede il completamento automatico. Se quanto scritto identifica univocamente il nome di una variabile, questo è scritto automaticamente; in caso di ambiguità appare una lista dalla quale selezionare le possibili alternative. Vedi esempio:

Non tutti potrebbero condividere queste regole, non importa, non sono scritte sulla pietra. L’importante è comprendere che l’assegnazione dei nomi delle variabili è da affrontare con un certo rigore, per cui invito caldamente questi comportamenti:

Darsi una regola. Che le regole siano quelle descritte sopra o siano altre l’importante è ci siano e che vengano rispettate. L’applicazione risulterà coerente e professionale.

Non tradire il nome della variabile. L’informazione contenuta nella variabile deve essere coerente con nome assegnato. Può succedere che, nel corso dello sviluppo, cambino le necessità e cambi l’informazione contenuta nella variabile. Lasciare il vecchio nome non è una buona pratica. Niente paura: con la funzione refactoring di CODESYS è possibile rinominare la variabile sostituendo tutte le occorrenze in cui la variabile è usata.

Curare la leggibilità. Lo scopo ultimo è mantenere una chiara leggibilità del codice scritto. Ricordare che, nella vita del software, mediamente una linea di codice è scritta una volta e letta dieci volte e la maggior parte delle volte questo lettore saremo ancora noi, aiutiamolo.