Programiranje ni samo vprašanje logike in sintakse, temveč tudi jasnosti in berljivosti. Dobro strukturirana aplikacija ne izboljšuje le tvojega razumevanja kode, temveč tudi olajša sodelovanje v ekipi. V tem priročniku se boš naučil, kako lahko s spoštovanjem imen-, kode- in postavitvenih-konvencij v C# učinkovito delaš.
Najpomembnejši vpogledi
Najpomembnejše točke, ki jih moraš vzeti iz tega priročnika, so:
- Imena razredov se vedno začnejo z veliko začetnico in uporabljajo Camel Case.
- Metode sledijo istim konvencijam kot imena razredov.
- Spremenljivke naj se začnejo z malo začetnico in naj besede prav tako pišejo v Camel Case.
- Jasna struktura in berljivost s pomočjo postavitvenih konvencij znatno povečata kakovost tvoje kode.
Navodila po korakih
1. Imena razredov
Začnimo z imeni razredov. Ta se morajo vedno začeti z veliko začetnico in ne smejo vsebovati presledkov. To preprečuje sintaktične napake. Če ime razreda sestavlja več besed, se uporablja tako imenovana Camel Case pisava. Prva beseda se začne z veliko začetnico, sledijo ji druge besede prav tako z veliko začetnico. Na primer, ime razreda bi lahko bilo "Program".
2. Imenovanje metod
Imenovanje metod poteka v največji meri podobno kot pri imenih razredov. Na primer metoda "KrogIzračunati". Tukaj se prvi črki "Krog" in "Izračunati" začneta z veliko začetnico. Spet se ne uporabljajo presledki, da bi ohranili strukturo metode.
3. Imenovanje argumentov metode
Pri imenovanju argumentov metode je treba upoštevati druge pravilnike. Ti bi se morali vedno začeti z malo začetnico. Na primer: pri metodi bi lahko argument imenovali "Arx", kar sledi mali začetnici.
4. Imenovanje spremenljivk
Zdaj preidimo na spremenljivke. Ta imena se običajno začnejo z malo začetnico, in če so sestavljena iz več besed, se preostale besede spet pišejo v Camel Case. Na primer ime spremenljivke "znakŠtevilo", pri čemer je "znak" pisano z malo in "Število" z veliko začetnico za izboljšanje berljivosti.
5. Kratice v imenih spremenljivk
Priporočljivo je, da se izogibate kraticam v imenih spremenljivk. Te lahko vodijo do nesporazumov. Pomemben vidik je tudi, da se spremenljivke nikoli ne smejo začeti s številko. Na primer: namesto da spremenljivko poimenuješ "5Število", bi moral uporabiti "število5". To izpolnjuje sintaktične zahteve Visual Studia.
6. Predpona za spremenljivke
Koristen trik je, da imenom spremenljivk dodaš predpono, ki označuje podatkovni tip. Na primer, pri celoštevilski spremenljivki se pred "i" doda, kar pomeni 32-bitno celo število. Polno ime bi lahko bilo "iŠtevilo5".
7. Upoštevanje postavitvenih konvencij
Na koncu je pomembno tudi oblikovanje kode, da se izboljša berljivost. Poskrbi, da bo v vsaki vrstici le ena izjava in da bo vsaka deklaracija dodeljena svoji vrstici. Drug vidik je pravilna uporaba tabulatork ali štirih presledkov za zamike.
8. Poglobitev in dodatne povezave
Če želiš še dodatno pridobiti znanje o tej temi, ti priporočam uradno Microsoftovo spletno stran. Tam najdeš podrobne informacije o konvencijah imen, smernicah za postavitve in komentarjih. Te informacije so zelo koristne za berljivost tvojega izvorne kode.
Povzetek – razumevanje konvencij imen, kode in postavitve C#
V tem priročniku si prejel obsežen pregled različnih konvencij imen, kode in postavitve v C#. Zdaj veš, kako ustrezno poimenovati razred, metode in spremenljivke ter kako pomembna je dosledna struktura za tvoje programiranje.
Pogosto zastavljena vprašanja
Kako začnem ime razreda?Imena razredov se vedno začnejo z veliko začetnico.
Kaj je Camel Case in kako ga uporabim?Camel Case pomeni, da se vsaka beseda v imenu začne z veliko začetnico, npr. "KrogIzračunati".
Ali lahko uporabim presledke v imenih spremenljivk?Ne, v imenih spremenljivk presledki niso dovoljeni.
Kako naj poimenujem svoje spremenljivke?Spremenljivke naj se začnejo z malo začetnico in naj uporabljajo Camel Case.
Ali lahko uporabljam kratice v imenih?Bolje je, da se izogibaš kraticam, da preprečiš zmedo.
