Kies namen van variabelen die voldoen aan regels en conventies
- 6 minuten
Een softwareontwikkelaar zei ooit: "Het moeilijkste deel van softwareontwikkeling is het benoemen van dingen." De naam van een variabele moet niet alleen bepaalde syntaxisregels volgen, maar moet ook worden gebruikt om de code beter leesbaar en begrijpelijker te maken. Dat is veel te vragen van één regel code!
Regels voor variabelenamen
Er zijn enkele regels voor variabelenamen die worden afgedwongen door de C#-compiler.
- Variabelenamen kunnen alfanumerieke tekens en het onderstrepingsteken (_) bevatten. Speciale tekens zoals het pond
#, het streepje-en het dollarteken$zijn niet toegestaan. - Namen van variabelen moeten beginnen met een alfabetische letter of een onderstrepingsteken, niet met een getal. Het gebruik van een onderstrepingsteken om een variabelenaam mee te beginnen, is meestal gereserveerd voor privé-exemplaarvelden. Een koppeling naar verder lezen vindt u in de modulesamenvatting.
- Namen van variabelen mogen geen C#-trefwoord zijn. Deze naamdeclaraties van variabelen zijn bijvoorbeeld niet toegestaan:
float float;ofstring string;. - Namen van variabelen zijn hoofdlettergevoelig, wat betekent dat
string MyValue;enstring myValue;twee verschillende variabelen zijn.
Naamconventies voor variabelen
Conventies zijn suggesties die zijn overeengekomen door de softwareontwikkelingscommunity. Hoewel u vrij bent om deze conventies niet te volgen, zijn ze zo populair dat het voor andere ontwikkelaars lastig kan zijn om uw code te begrijpen. U moet oefenen met het aannemen van deze conventies en ze deel laten uitmaken van uw eigen coderingsgewoonten.
- Variabelenamen moeten camelCase gebruiken. Dit is een schrijfwijze waarbij het eerste woord begint met een kleine letter en elk volgend woord met een hoofdletter. Voorbeeld:
string thisIsCamelCase;. - Namen van variabelen moeten beschrijvend en zinvol zijn in uw toepassing. U moet een naam kiezen voor uw variabele die het type gegevens vertegenwoordigt dat wordt opgeslagen (niet het gegevenstype). Bijvoorbeeld:
bool orderComplete;, NIETbool isComplete;. - Namen van variabelen moeten een of meer volledige woorden zijn die aan elkaar zijn toegevoegd. Gebruik geen contracties omdat de naam van de variabele mogelijk onduidelijk is voor anderen die uw code lezen. Bijvoorbeeld:
decimal orderAmount;, NIETdecimal odrAmt;. - Namen van variabelen mogen niet het gegevenstype van de variabele bevatten. Misschien zie je wat advies om een stijl zoals
string strMyValue;te gebruiken. Het was een populaire stijl jaren geleden. De meeste ontwikkelaars volgen dit advies echter niet meer en er zijn goede redenen om het niet te gebruiken.
Het voorbeeld string firstName; volgt al deze regels en conventies, ervan uitgaande dat u deze variabele wilt gebruiken om gegevens op te slaan die de voornaam van iemand vertegenwoordigen.
Voorbeelden van variabelenamen
Hier volgen enkele voorbeelden van variabeledeclaraties (met behulp van algemene gegevenstypen):
char userOption;
int gameScore;
float particlesPerMillion;
bool processedCustomer;
Andere naamconventies
De hierboven beschreven regels en conventies zijn bedoeld voor lokale variabelen. Een lokale variabele is een variabele die binnen de hoofdtekst van een methode valt, of een variabele in een consoletoepassing die gebruikmaakt van instructies op het hoogste niveau (zoals de code in deze module).
Er zijn andere soorten constructies die u in uw toepassingen kunt gebruiken en velen hebben hun eigen conventies. Klassen worden bijvoorbeeld vaak gebruikt in C#-programmering en hebben bijbehorende conventies. Hoewel u geen klassen in deze module gaat maken, is het belangrijk dat u weet dat de naamconventies die u zojuist hebt geleerd, in een groter naamgevingsframework passen.