Data aggiornamento: luglio 2025.
Quanto è importante commentare il software del PLC? Che tipo di documentazione è necessario redigere? Cosa sono i commenti di ramo, di istruzione, e di indirizzo?
Benvenuto in questa lezione di progettazione software plc. Oggi parliamo della documentazione che accompagna questo tipo di programmi, e della sua importanza.
Qualsiasi lavoro di concetto richiede della documentazione, e la programmazione PLC non fa eccezione. Oltre ai disegni tecnici e agli schemi, quando si costruisce un software è necessario documentarlo in maniera chiara e dettagliata.
La documentazione del programma serve sia a chi lo scrive, che a chi dovrà leggerlo in seguito, magari per fare delle modifiche, o per il troubleshooting.
Vediamo ora che tipo di commenti è possibile inserire in un programma PLC, e successivamente quale documentazione si può allegare al software.
1. Tipi di commenti del programma PLC.
Ci sono piccole variazioni nella gestione dei commenti nei vari tools di programmazione. Queste sono minime, e tutte le considerazione che facciamo in questa lezione sono valide per praticamente tutti i maggiori ambienti forniti da Siemens, Allen Bradley, Schneider, Omron, Codesys.
Ecco che tipo di commento possiamo inserire nel programma:
a) Intestazione e commenti di riga: quando si costruisce il programma, esso viene suddiviso in righe (rung, o rami). Ogni riga può avere un intestazione e un commento. Solitamente l’intestazione è visibile anche quando i rami sono compressi; avendo l’intestazione visibile possiamo facilmente rintracciare ogni ramo.
Le intestazioni possono anche servire per commentare in maniera generale le funzioni di un gruppo di righe.
Il commento della riga può essere più esteso dell’intestazione, e viene utilizzato per scrivere delle note sul funzionamento di ciò che la riga esegue.
b) Commento di istruzione: questo commento è legato alla particolare istruzione che lo contiene, indipendentemente dalle variabili utilizzate dall’istruzione stessa.
c) Commento di indirizzo: è un commento legato alle variabili (specificate simbolicamente o con indirizzi), indipendentemente dalle istruzioni che utilizzano quelle variabili.
Solitamente si scrivono: l’intestazione del ramo, per poterlo individuare velocemente tra tanti rami del programma, e il commento degli indirizzi. Il commento delle istruzioni è meno impiegato.
2. Documentazione allegabile al programma PLC.
Quando si consegna il software del plc, può essere richiesto di allegare anche una documentazione cartacea, oppure documenti elettronici come file PDF. Questa documentazione può comprendere:
a) Listato dei programmi, con relativi commenti di riga e di indirizzi.
b) Stampa della cross reference (riferimenti utilizzati per rintracciare ogni variabile all’interno del listato).
c) Tabelle di occupazione memoria, per individuare facilmente indirizzi liberi, oltre che il raggruppamento logico delle variabili che occupano la memoria.
Naturalmente il tipo di documentazione da fornire viene decisa dal committente, così come la lingua da utilizzare per produrla. Spesso si crea la documentazione in due lingue: quella del programmatore, e quella del cliente. In caso non ci fosse una precisa indicazione, è buona norma commentare e documentare il programma in inglese; questo si verifica quando il software ha come destinazione estera.