Välj variabelnamn som följer regler och konventioner
- 6 minuter
En programutvecklare sa en gång berömdt, "Den svåraste delen av programvaruutveckling är att namnge saker." Namnet på en variabel måste inte bara följa vissa syntaxregler, det bör också användas för att göra koden mer läsbar och begriplig för människor. Det är mycket att begära av en kodrad!
Regler för variabelnamn
Det finns vissa regler för variabelnamngivning som tillämpas av C#-kompilatorn.
- Variabelnamn kan innehålla alfanumeriska tecken och understreck (_). Specialtecken som pundet
#, strecket-och dollartecknet$är inte tillåtna. - Variabelnamn måste börja med en alfabetisk bokstav eller ett understreck, inte ett tal. Användning av ett understreckstecken för att starta ett variabelnamn är vanligtvis reserverat för privata instansfält. En länk till ytterligare läsning finns i modulsammanfattningen.
- Variabelnamn får INTE vara ett C#-nyckelord. Dessa deklarationer för variabelnamn tillåts till exempel inte:
float float;ellerstring string;. - Variabelnamn är skiftlägeskänsliga, vilket innebär att
string MyValue;ochstring myValue;är två olika variabler.
Konventioner för variabelnamn
Konventioner är förslag som avtalas av programvaruutvecklingscommunityn. Du kan välja att inte följa dessa konventioner, men de är så populära att det kan göra det svårt för andra utvecklare att förstå din kod. Du bör öva på att anta dessa konventioner och göra dem till en del av dina egna kodningsvanor.
- Variabelnamn bör använda camel case, vilket är en skrivstil som börjar med en gemen bokstav i det första ordet och en versal i början av varje ord därefter. Till exempel:
string thisIsCamelCase;. - Variabelnamn bör vara beskrivande och meningsfulla i ditt program. Du bör välja ett namn på variabeln som representerar vilken typ av data den ska innehålla (inte datatypen). Till exempel:
bool orderComplete;, NOTbool isComplete;. - Variabelnamn ska vara ett eller flera hela ord som läggs ihop. Använd inte sammandragningar eftersom namnet på variabeln kan vara oklart för andra som läser koden. Till exempel:
decimal orderAmount;, NOTdecimal odrAmt;. - Variabelnamn får inte innehålla variabelns datatyp. Du kan få några råd om att använda en stil som
string strMyValue;. Det var en populär stil för flera år sedan. De flesta utvecklare följer dock inte det här rådet längre och det finns goda skäl att inte använda det.
Exemplet string firstName; följer alla dessa regler och konventioner, förutsatt att du vill använda den här variabeln för att lagra data som representerar någons förnamn.
Exempel på variabelnamn
Här är några exempel på variabeldeklarationer (med vanliga datatyper):
char userOption;
int gameScore;
float particlesPerMillion;
bool processedCustomer;
Andra namngivningskonventioner
Reglerna och konventionerna som beskrivs ovan gäller för lokala variabler. En lokal variabel är en variabel som är begränsad till en metods brödtext eller en variabel i ett konsolprogram som använder instruktioner på toppnivå (till exempel koden i den här modulen).
Det finns andra typer av konstruktioner som du kan använda i dina program och många har egna konventioner. Klasser används till exempel ofta i C#-programmering och har associerade konventioner. Även om du inte kommer att skapa klasser i den här modulen är det viktigt att du vet att namngivningskonventionerna som du just har lärt dig passar in i ett större namngivningsramverk.