Sintassi e convenzioni
Questa pagina definisce le convenzioni sintattiche per nomi e strutture usate nei blocchi del programma. L’obiettivo è garantire coerenza, leggibilità e diagnosi efficace del comportamento del software.
Regole generali di nomenclatura
- Usa nomi descrittivi e coerenti (evita abbreviazioni ambigue).
- Lingua consigliata per gli identificatori: inglese tecnico (es. speed, status, errorCode).
Costanti
Le costanti devono essere scritte in maiuscolo con underscore tra le parole.
Esempi:
- MAX_SPEED
- TIMEOUT_MS
- DEFAULT_RETRY_COUNT
Note:
- Le costanti non usano prefissi come
soz.
Variabili interne al blocco (Static/Temp)
Le variabili utilizzate all’interno del blocco si indicano con il prefisso z.
Regole:
- Prefisso:
z. (es.zCounter,zSpeedRef,zIsEnabled). - Scopo: variabili di lavoro private al blocco (statiche o temporanee).
- Non esporle all’esterno né riutilizzarle come variabili di visualizzazione.
Variabili di visualizzazione
Le variabili destinate al monitoraggio o alla visualizzazione usano il prefisso v.
Regole:
- Prefisso:
v. (es.vSpeed,vRef,vStatus,vErrorCode). - Scopo: rendere osservabile lo stato del blocco; preferibilmente in sola lettura dall’esterno.
- Non usarle come variabili di lavoro interne.
Esempi rapidi
- Costante:
MAX_SPEED = 1200 - Variabile interna:
zSpeedRef - Variabile diagnostica:
vSpeed,vErrorCode
La coerenza delle convenzioni è più importante del singolo stile: attenersi a queste regole rende il codice più chiaro e facile da manutenere.