Scegliere nomi di variabili che seguono regole e convenzioni
- 6 minuti
Uno sviluppatore di software ha detto una volta in modo famoso: "La parte più difficile dello sviluppo di software è la denominazione delle cose". Non solo il nome di una variabile deve seguire determinate regole di sintassi, ma deve essere usato anche per rendere il codice più leggibile e comprensibile. Questo è molto per una sola riga di codice!
Regole per i nomi di variabili
Esistono alcune regole di denominazione delle variabili applicate dal compilatore C#.
- I nomi delle variabili possono contenere caratteri alfanumerici e il carattere di sottolineatura (_). I caratteri speciali come la sterlina
#, il trattino-e il segno$di dollaro non sono consentiti. - I nomi delle variabili devono iniziare con una lettera alfabetica o un carattere di sottolineatura, non un numero. L'uso di un carattere di sottolineatura per iniziare un nome di variabile è in genere riservato ai campi di istanza privata. Un collegamento per altre informazioni è disponibile nel riepilogo del modulo.
- I nomi delle variabili non devono essere una parola chiave C#. Ad esempio, queste dichiarazioni di nome variabile non saranno consentite:
float float;ostring string;. - I nomi delle variabili fanno distinzione tra maiuscole e minuscole, vale a dire che
string MyValue;estring myValue;sono due variabili diverse.
Convenzioni per i nomi di variabili
Le convenzioni sono suggerimenti concordati dalla community di sviluppo software. Anche se si è liberi di decidere di non seguire queste convenzioni, sono così popolari che potrebbero rendere difficile per altri sviluppatori comprendere il codice. È consigliabile praticare l'adozione di queste convenzioni e renderle parte delle proprie abitudini di codifica.
- I nomi delle variabili devono usare il camel case, uno stile di scrittura che utilizza una minuscola all'inizio della prima parola e una maiuscola all'inizio di ogni parola successiva. Ad esempio:
string thisIsCamelCase;. - I nomi delle variabili devono essere descrittivi e significativi nell'applicazione. È consigliabile scegliere un nome per la variabile che rappresenta il tipo di dati che conterrà (non il tipo di dati). Ad esempio:
bool orderComplete;, NOTbool isComplete;. - I nomi delle variabili devono essere una o più parole intere aggiunte insieme. Non usare contrazioni perché il nome della variabile potrebbe non essere chiaro ad altri che leggono il tuo codice. Ad esempio:
decimal orderAmount;, NOTdecimal odrAmt;. - I nomi delle variabili non devono includere il tipo di dati della variabile. Potrebbero essere visualizzati alcuni consigli per usare uno stile come
string strMyValue;. Era uno stile popolare anni fa. Tuttavia, la maggior parte degli sviluppatori non segue più questo consiglio e ci sono buoni motivi per non usarlo.
L'esempio string firstName; segue tutte queste regole e convenzioni, presupponendo che si voglia usare questa variabile per archiviare i dati che rappresentano il nome di un utente.
Esempi di nomi di variabile
Ecco alcuni esempi di dichiarazioni di variabili (usando tipi di dati comuni):
char userOption;
int gameScore;
float particlesPerMillion;
bool processedCustomer;
Altre convenzioni di denominazione
Le regole e le convenzioni descritte in precedenza sono relative alle variabili locali. Una variabile locale è una variabile con ambito all'interno del corpo di un metodo o una variabile in un'applicazione console che usa istruzioni di primo livello, ad esempio il codice in questo modulo.
Esistono altri tipi di costrutti che è possibile usare nelle applicazioni e molte hanno convenzioni personalizzate. Ad esempio, le classi vengono spesso usate nella programmazione C# e hanno convenzioni associate. Sebbene non si creino classi in questo modulo, è importante sapere che le convenzioni di denominazione appena apprese rientrano in un framework di denominazione più ampio.