Programmeerimine ei ole mitte ainult loogika ja süntaksi küsimus, vaid ka selguse ja loetavuse küsimus. Hästi struktureeritud rakendus parandab mitte ainult sinu enda arusaamatust koodist, vaid lihtsustab ka koostööd meeskonnas. Selles juhendis saad teada, kuidas saad C#-s efektiivselt töötada, järgides nime-, koodi- ja kujundus-konventsioone.
Olulised järeldused
Olulised punktid, mida sa peaksid sellest juhendist endaga kaasa võtma, on:
- Klassinimed hakkavad alati suure tähega ja kasutavad Camel Case'i.
- Meetodid järgivad samu konventsioone kui klassinimed.
- Muuttähed peaksid algama väikese tähega ja nende sõnad peaksid samuti olema Camel Case'is.
- Selge struktuur ja loetavus kujunduskonventsioonide kaudu suurendavad sinu koodi kvaliteeti oluliselt.
Samm-sammult juhend
1. Klassinimed
Alustame klassinimedest. Need peaksid alati alustama suure tähega ja ei tohi sisaldada tühikuid. See ennetab süntaksivigu. Kui klassi nimi koosneb mitmest sõnast, kasutatakse nn Camel Case kirjutamisstiili. Esimene sõna algab suure tähega, järgneb teistele sõnadele, samuti suurtähtedega. Näiteks võiks klassi nimi olla "Programm".
2. Meetodite nimetamine
Meetodite nimetamine toimub võrdselt sarnasel viisil nagu klassinimed. Võtame näiteks meetodi "KreisBerechnen". Siin algab esimene täht sõnades "Kreis" ja "Berechnen" mõlemad suure tähega. Siingi ei kasutata tühikuid meetodilise struktuuri säilitamiseks.
3. Meetodi argumentide nimetamine
Meetodi argumentide nimetamisel tuleb järgida teisi reegleid. Need peaksid alati algama väikese tähega. Näiteks: meetodi puhul võiks argument olla nimetatud "Arx", mis järgneb väikesele täheline kirjutamine.
4. Muuttähede nimetamine
Nüüd tuleme muuttähtede juurde. Need nimed algavad tavaliselt väikese tähega ja kui need koosnevad mitmest sõnast, tulevad järgmised sõnad taas Camel Case’is. Näiteks on muuttähtede nimi "zeichenAnzahl", kus "zeichen" on väikese ja "Anzahl" suure tähega, et suurendada loetavust.
5. Lühendite kasutamine muuttähtedes
On soovitatav vältida lühendeid muuttähtedes. Need võivad põhjustada arusaamatusi. Oluline aspekt on ka see, et muuttähed ei tohiks kunagi alata numbriga. Näiteks: selle asemel, et nimetada muuttäht "5Zahl", peaksid kasutama "zahl5". See täidab Visual Studio süntaktilisi nõudeid.
6. Eesliide muuttähtedele
Kasulik trikk on anda muuttähtedele eesliide, mis näitab andmetüüpi. Näiteks, kui on tegemist tervete numbritega, lisatakse "i", mis tähendab 32-bitist tärkliha. Täielik nimi võiks olla "iZahl5".
7. Kujunduskonventsioonide järgimine
Lõpetuseks on koodi kujundus oluline, et parandada loetavust. Veendu, et igas reas oleks ainult üks käsk ja et iga deklareerimine oleks omaette real. Veel üks punkt on tabulatsioonide või nelja tühiku õige kasutamine sissetõmbamiseks.
8. Süvitsi minek ja täiendavad lingid
Kui soovid teemat süvitsi uurida, soovitan sul külastada ametlikku Microsofti veebisaiti. Sealt leiad üksikasjalikke teavet nimekonventsioonide, kujunduse juhiste ja kommentaaride kohta. Need teave on väga kasulik, et parandada sinu allika koodi loetavust.
Kokkuvõte – C# nime-, koodi- ja kujunduskonventsioonide mõistmine
Selles juhendis oled saanud põhjaliku ülevaate erinevatest nime-, koodi- ja kujunduskonventsioonidest C#-s. Sa tead nüüd, kuidas nimetada klassinimesid, meetodeid ja muuttähti ning kui oluline on ühtne struktuur sinu programmeerimistöös.
Korduma kippuvad küsimused
Kuidas alustada klassinime?Klassinimed algavad alati suure tähega.
Mis on Camel Case ja kuidas seda rakendada?Camel Case tähendab, et iga sõna nimes algab suure tähega, nt "KreisBerechnen".
Kas ma võin kasutda tühikuid muuttähtedes?Ei, tühikuid ei lubata muuttähtedes.
Kuidas peaksin oma muuttähti nimetama?Muuttähed peaksid algama väikese tähega ja kasutama Camel Case'i.
Kas ma tohin kasutada lühendeid nimedes?On parem vältida lühendeid, et vältida segadust.
