Programavimas nėra tik logikos ir sintaksės klausimas, bet taip pat aiškumo ir skaitomumo. Gerai struktūruota programa ne tik pagerina tavo pačių supratimą apie kodą, bet ir palengvina bendradarbiavimą komandoje. Šiame vadove sužinosi, kaip efektyviai dirbti C# laikydamasis pavadinimų, kodo ir maketo konvencijų.
Svarbiausios įžvalgos
Svarbiausi dalykai, kuriuos turėtum išsinešti iš šio vadovo, yra:
- Klasės pavadinimai visada prasideda didžiąja raide ir naudoja Camel Case.
- Metodai laikosi tokių pačių konvencijų kaip ir klasės pavadinimai.
- Vardinės turėtų prasidėti mažąja raide ir jų žodžiai taip pat turėtų būti rašomi Camel Case.
- Aiški struktūra ir skaitomumas, laikantis maketo konvencijų, žymiai pagerina tavo kodo kokybę.
Žingsnis po žingsnio vadovas
1. Klasės pavadinimai
Pirmiausia pradėkime nuo klasių pavadinimų. Šie visada turėtų prasidėti didžiąja raide ir neturėtų turėti tarpų. Tai padeda išvengti sintaksės klaidų. Jei klasės pavadinimas susideda iš kelių žodžių, taikoma vadinamoji Camel Case rašyba. Pirmasis žodis prasideda didžiąja raide, po kurio seka kiti žodžiai, taip pat rašomi didžiosiomis raidėmis. Pavyzdžiui, klasės pavadinimas galėtų būti "Programas".
2. Metodų pavadinimai
Metodų pavadinimas labai panašus į klasių pavadinimus. Pavyzdžiui, metodas "ApskaičiuotiApskritimą". Čia pirmasis raidė "Apskritimas" ir "Apskaičiuoti" kiekviena prasideda didžiąja raide. Ir čia tarpai nenaudojami, kad išlaikytume metodinę struktūrą.
3. Metodų argumentų pavadinimai
Argumentų pavadinime turi būti laikomasi kitų taisyklių. Jie visada turėtų prasidėti mažąja raide. Pavyzdžiui, metodui gali būti suteiktas argumentas "Arx", kuris prasideda mažąja raide.
4. Kintamųjų pavadinimai
Dabar pereikime prie kintamųjų. Šie pavadinimai paprastai prasideda mažąja raide, o jei jie susideda iš kelių žodžių, kiti žodžiai taip pat rašomi Camel Case. Pavyzdys – kintamojo pavadinimas "ženklųSkaičius", kuriame "ženklų" mažąja raide, o "Skaičius" didžiąja, kad padidintų skaitomumą.
5. Sutrumpinimų naudojimas kintamųjų pavadinimuose
Rekomenduojama vengti sutrumpinimų kintamųjų pavadinimuose. Tai gali sukelti nesusipratimų. Svarbus aspektas yra tai, kad kintamieji niekada neturėtų prasidėti skaičiumi. Pavyzdys: vietoj kintamojo "5Skaičius" turėtum naudoti "skaičius5". Tai atitinka Visual Studio sintaksės reikalavimus.
6. Kintamųjų prefiksas
Naudingas triukas yra pridėti prie kintamojo pavadinimo prefiksą, nurodantį duomenų tipą. Pavyzdžiui, int tipo kintamajam "i" pridedama, kas nurodo 32 bitų sveiką skaičių. Pilnas pavadinimas galėtų būti "iSkaičius5".
7. Laikykitės maketo konvencijų
Baigiant, svarbu laikytis kodo maketo, norint pagerinti skaitomumą. Įsitikink, kad kiekvienoje eilutėje yra tik viena instrukcija ir kad kiekvienas deklaravimas priskirtas savo eilutei. Dar vienas dalykas yra teisingas tabuliavimo arba keturių tarpų naudojimas įtraukimo atvejais.
8. Gylis ir papildomi šaltiniai
Jei nori gilinti šią temą, rekomenduoju oficialią Microsoft svetainę. Ten rasi išsamią informaciją apie pavadinimų konvencijas, maketo gaires ir komentarus. Ši informacija labai naudinga tavo šaltinio kodo skaitomumui.
Santrauka – Suprasti C# pavadinimų, kodo ir maketo konvencijas
Šiame vadove gavai išsamų supratimą apie įvairias pavadinimų, kodo ir maketo konvencijas C#. Dabar žinai, kaip tinkamai pavadinti klasių, metodų ir kintamųjų pavadinimus bei kaip svarbu yra vienoda struktūra tavo programavimo darbe.
Dažnai užduodami klausimai
Kaip pradėti klasės pavadinimą?Klasės pavadinimai visada prasideda didžiąja raide.
Kas yra Camel Case ir kaip jį naudoti?Camel Case reiškia, kad kiekvienas žodis pavadinime prasideda didžiąja raide, pvz., "ApskaičiuotiApskritimą".
Ar galiu naudoti tarpus kintamųjų pavadinimuose?Ne, tarpai kintamųjų pavadinimuose nėra leidžiami.
Kaip turėčiau pavadinti savo kintamuosius?Kintamieji turėtų prasidėti mažąja raide ir naudoti Camel Case.
Ar galiu naudoti sutrumpinimus pavadinimuose?Geriau vengti sutrumpinimų, kad būtų išvengta painiavos.
