Programmering er ikke kun et spørgsmål om logik og syntaks, men også om klarhed og læsbarhed. En velstruktureret applikation forbedrer ikke kun din egen forståelse af koden, men letter også samarbejdet i teamet. I denne vejledning lærer du, hvordan du kan arbejde effektivt i C# ved at følge navngivnings-, kode- og layout-konventioner.
Vigtigste indsigter
De vigtigste punkter, du bør tage med dig fra denne vejledning, er:
- Klassernavne begynder altid med et stort bogstav og bruger Camel Case.
- Metoder følger de samme konventioner som klassernavne.
- Variabler bør begynde med et lille bogstav og også skrive deres ord i Camel Case.
- En klar struktur og læsbarhed gennem layout-konventioner forbedrer kvaliteten af din kode betydeligt.
Trin-for-trin vejledning
1. Klassernavne
Lad os starte med klassernavnene. Disse bør altid begynde med et stort bogstav og må ikke indeholde mellemrum. Dette forhindrer syntaktiske fejl. Hvis et klassernavn består af flere ord, anvendes den såkaldte Camel Case-skrivemåde. Det første ord begynder med et stort bogstav, efterfulgt af yderligere ord, også med stort begyndelsesbogstav. For eksempel kunne klassernavnet være "Program".
2. Navngivning af metoder
Navngivningen af metoder sker i høj grad på samme måde som for klassernavne. Tag for eksempel metoden "KreisBerechnen". Her begynder det første bogstav af "Kreis" og "Berechnen" hver med et stort bogstav. Igen bruges der ikke mellemrum for at bevare den metodiske struktur.
3. Navngivning af argumenter i en metode
Ved navngivning af argumenterne i en metode skal andre regler overholdes. Disse bør altid begynde med et lille bogstav. Eksempel: I en metode kunne argumentet navngives "Arx", hvilket følger små bogstaver.
4. Navngivning af variabler
Nu kommer vi til variablerne. Disse navne begynder normalt med et lille bogstav, og hvis de består af flere ord, kommer de øvrige ord også i Camel Case. Et eksempel er variabelnavnet "zeichenAnzahl", hvor "zeichen" er lille og "Anzahl" skrives med stort for at øge læsbarheden.
5. Forkortelser i variabelnavne
Det er tilrådeligt at undgå forkortelser i variabelnavne. Disse kan føre til misforståelser. Et vigtigt aspekt er desuden, at variabler aldrig bør begynde med et tal. Et eksempel: I stedet for at navngive variablen "5Zahl", bør du bruge "zahl5". Dette opfylder de syntaktiske krav fra Visual Studio.
6. Præfix til variabler
Et nyttigt trick er at tilføje et præfix til variabelnavne, der angiver datatypen. For eksempel foran en integer-variabel sættes "i", som står for en 32-bit heltal. Det fulde navn kunne derfor være "iZahl5".
7. Overhold layout-konventioner
Endelig er layoutet af koden vigtigt for at forbedre læsbarheden. Sørg for, at der kun står én erklæring pr. linje, og at hver erklæring tildeles sin egen linje. Et andet punkt er den korrekte brug af tabulatorer eller fire mellemrum til indrykning.
8. Fordybelse og yderligere links
Hvis du ønsker at fordybe dig mere i emnet, anbefaler jeg dig den officielle Microsoft-hjemmeside. Der finder du detaljerede oplysninger om navngivningskonventioner, layoutretningslinjer og kommentarer. Disse oplysninger er meget nyttige for læsbarheden af din kildekode.
Sammenfatning – Forstå C# navngivnings-, kode- og layoutkonventioner
I denne vejledning har du fået et omfattende overblik over de forskellige navngivnings-, kode- og layoutkonventioner i C#. Du ved nu, hvordan du navngiver klassernavne, metoder og variabler korrekt og hvor vigtig en ensartet struktur er for dit programmeringsarbejde.
Ofte stillede spørgsmål
Hvordan starter jeg et klassernavn?Klassernavne begynder altid med et stort bogstav.
Hvad er Camel Case, og hvordan anvender jeg det?Camel Case betyder, at hvert ord i et navn starter med et stort bogstav, f.eks. "KreisBerechnen".
Må jeg bruge mellemrum i variabelnavne?Nej, mellemrum er ikke tilladt i variabelnavne.
Hvordan skal jeg navngive mine variabler?Variabler bør begynde med et lille bogstav og bruge Camel Case.
Kan jeg bruge forkortelser i navne?Det er bedre at undgå forkortelser for at undgå forvekslinger.
