Programmering er ikke bare et spørsmål om logikk og syntaks, men også om klarhet og lesbarhet. En godt strukturert applikasjon forbedrer ikke bare din egen forståelse av koden, men letter også samarbeidet i teamet. I denne guiden vil du lære hvordan du kan jobbe effektivt i C# ved å overholde navn-, kode- og layout-konvensjoner.
Viktigste funn
De viktigste punktene du bør ta med deg fra denne guiden er:
- Klassens navn begynner alltid med stor bokstav og bruker Camel Case.
- Metoder følger de samme konvensjonene som klassens navn.
- Variabler bør begynne med liten bokstav og skrive ordene i Camel Case.
- En klar struktur og lesbarhet gjennom layout-konvensjoner øker kvaliteten på koden din betydelig.
Trinn-for-trinn-guide
1. Klassens navn
Så begynner vi med klassens navn. Disse bør alltid begynne med stor bokstav og ikke inneholde mellomrom. Dette forhindrer syntaktiske feil. Hvis et klassenavn består av flere ord, brukes den såkalte Camel Case-skrivemåten. Det første ordet begynner med stor bokstav, etterfulgt av andre ord, også i stor skrift. For eksempel kan klassenavnet være "Program".
2. Navn på metoder
Naming of methods is done in much the same way as class names. For example, the method "KreisBerechnen". Here, the first letter of "Kreis" and "Berechnen" each starts with a capital letter. Again, no spaces are used to maintain the methodical structure.
3. Navngi argumentene til en metode
Når du gir navn til argumentene til en metode, må du ta hensyn til andre regler. Disse bør alltid starte med liten bokstav. Eksempel: I en metode kan argumentet kalles "Arx", som følger liten bokstav.
4. Navngi variabler
Nå kommer vi til variablene. Disse navnene begynner vanligvis med liten bokstav, og hvis de består av flere ord, kommer de andre ordene igjen i Camel Case. Et eksempel er variabelnavnet "zeichenAnzahl", hvor "zeichen" skrives med liten bokstav og "Anzahl" med stor bokstav for å øke lesbarheten.
5. Forkortelser i variabelnavn
Det er lurt å unngå forkortelser i variabelnavn. Dette kan føre til misforståelser. Et viktig aspekt er også at variablene aldri skal begynne med et tall. Et eksempel: I stedet for å kalle variabelen "5Zahl", burde du bruke "zahl5". Dette oppfyller de syntaktiske kravene fra Visual Studio.
6. Prefiks for variabler
Et nyttig triks er å gi variabelnavn et prefiks som angir datatypen. For eksempel, i en integer-variabel settes det "i" foran, som står for en 32-bits heltall. Det komplette navnet kan da være "iZahl5".
7. Vær oppmerksom på layout-konvensjoner
Avslutningsvis er det viktig med layouten av koden for å forbedre lesbarheten. Pass på at hver linje inneholder bare én instruksjon, og at hver deklarasjon tildeles sin egen linje. Et annet punkt er riktig bruk av tabulatorer eller fire mellomrom for innrykk.
8. Fordypning og videre lenker
Hvis du ønsker å fordype deg videre i emnet, anbefaler jeg deg å besøke den offisielle Microsoft-nettsiden. Der finner du detaljert informasjon om navnekonvensjoner, layout-retningslinjer og kommentarer. Denne informasjonen er svært nyttig for lesbarheten av kildekoden din.
Sammendrag – Forstå C# navn-, kode- og layout-konvensjoner
I denne guiden har du fått en omfattende oversikt over de ulike navn-, kode- og layout-konvensjonene i C#. Du vet nå hvordan du navngir klassenavn, metoder og variabler, og hvor viktig en enhetlig struktur er for programmeringsarbeidet ditt.
Ofte stilte spørsmål
Hvordan begynner jeg et klassenavn?Klassens navn begynner alltid med stor bokstav.
Hva er Camel Case og hvordan bruker jeg det?Camel Case betyr at hvert ord i et navn begynner med stor bokstav, f.eks. "KreisBerechnen".
Kan jeg bruke mellomrom i variabelnavn?Nei, mellomrom er ikke tillatt i variabelnavn.
Hvordan bør jeg navngi variablene mine?Variabler bør begynne med liten bokstav og bruke Camel Case.
Kan jeg bruke forkortelser i navnene?Det er bedre å unngå forkortelser for å forhindre forvirring.
