Naming: Every Developer's Nightmare
In informatica una delle principali attività è dare un nome alle variabili e alle funzioni. E nel nome caratterizzare il funzionamento di queste entità. Un nome ben scelto può facilitare le cose e migliorare la qualità del programma, ed il suo debugging.
Può essere utile usare lo schema [scope][typePrefix][baseName][qualifier][typeSuffix] per dare un nome efficace alle variabili. Porsi domande sull'ambito, il prefisso del tipo, il nome di base, il qualificatore e il suffisso del tipo della variabile può aiutare a creare un nome significativo.
Perché è importante: Dare un nome efficace alle variabili può migliorare la leggibilità e la manutenibilità del codice. L'uso di uno schema di denominazione coerente può facilitare la comprensione dello scopo di una variabile.
Aspetti fondamentali: Considerare la visibilità, le caratteristiche del linguaggio e le convenzioni di denominazione quando si determina l'ambito di una variabile.
Usare prefissi di tipo come "is", "has", "contains" o "integrates" per descrivere lo stato, la condizione o l'azione della variabile.
Scegliete un nome di base chiaro e conciso che descriva lo scopo principale della variabile.
Aggiungete un qualificatore per distinguere la variabile da altre con uno scopo simile.
Usare un suffisso di tipo per chiarire lo scopo o la struttura fondamentale della variabile.
Usare le variabili come commenti per migliorare la leggibilità del codice ed evitare commenti eccessivi.
Il quadro generale: Una denominazione efficace delle variabili è una parte importante della scrittura di codice manutenibile. L'uso di uno schema di denominazione coerente può facilitare la comprensione dello scopo di una variabile e migliorare la leggibilità del codice. L'uso delle variabili come commenti può aiutare a evitare commenti eccessivi e a migliorare la leggibilità del codice.
image credit: Experimental Alphabet