Ohjelmointi ei ole vain kysymys logiikasta ja syntaksista, vaan myös selkeydestä ja luettavuudesta. Hyvin rakennetun sovelluksen avulla voit parantaa omaa ymmärrystäsi koodista ja helpottaa tiimityöskentelyä. Tässä oppaassa opit, kuinka voit työskennellä tehokkaasti C#:ssa noudattamalla nimimäärittely, koodi- ja rakennuskonventioita.
Tärkeimmät havainnot
Merkittävimmät seikat, jotka sinun tulisi oppia tästä oppaasta, ovat:
- Luokkien nimet alkavat aina isolla kirjaimella ja käyttävät Camel Casea.
- Menetelmät noudattavat samoja konventioita kuin luokkien nimet.
- Muuttujat tulisi aloittaa pikkukirjaimella ja kirjoittaa niiden sanat myös Camel Case -tyyppisesti.
- Selkeä rakenne ja luettavuus rakennuskonventioiden avulla parantavat koodisi laatua merkittävästi.
Vaiheittainen opas
1. Luokkien nimet
Aloitetaan luokkien nimistä. Niiden tulisi aina alkaa isolla kirjaimella, eikä niiden saa sisältää tyhjää tilaa. Tämä estää syntaksivirheitä. Jos luokan nimi koostuu useista sanoista, käytetään niin kutsuttua Camel Case -kirjoitustapaa. Ensimmäinen sana alkaa isolla kirjaimella, jota seuraavat muut sanat myös isoilla. Esimerkiksi luokan nimi voisi olla "Ohjelma".
2. Menetelmien nimeäminen
Menetelmien nimeämisessä käytetään pääsääntöisesti samoja sääntöjä kuin luokkien nimissä. Ota esimerkiksi menetelmä "YmpyräLaske". Tässä "Ympyrä" ja "Laske" alkavat molemmat isolla kirjaimella. Myös tässä ei käytetä tyhjää tilaa, jotta menetelmän rakenne säilyy.
3. Menetelmän argumenttien nimeäminen
Menetelmän argumenttien nimeämisessä on huomioitava muita sääntöjä. Nämä tulisi aina aloittaa pikkukirjaimella. Esimerkiksi: Menetelmässä argumentti "Arx" voisi olla nimetty, mikä noudattaa pikkukirjainta.
4. Muuttujien nimeäminen
Siirrytään nyt muuttujiin. Näiden nimet alkavat yleensä pikkukirjaimella, ja jos ne koostuvat useista sanoista, muut sanat kirjoitetaan jälleen Camel Case -tyyppisesti. Esimerkki on muuttujan nimi "merkkiLuku", jossa "merkki" kirjoitetaan pienellä ja "Luku" isolla lisäten luettavuutta.
5. Lyhenteet muuttujan nimissä
On suositeltavaa välttää lyhenteiden käyttöä muuttujan nimissä. Ne voivat johtaa väärinkäsityksiin. Toinen tärkeä seikka on, että muuttujat eivät koskaan saisi alkaa numerolla. Esimerkiksi: Sen sijaan, että nimet lasketaan "5Luku", sinun tulisi käyttää "luku5". Tämä täyttää Visual Studion syntaktiset vaatimukset.
6. Etuliite muuttujille
Hyvä kikka on aloittaa muuttujan nimi etuliitteellä, joka osoittaa tietotyypin. Esimerkiksi, jos kyseessä on kokonaislukumuuttuja, etuliitteenä voisi olla "i", joka tarkoittaa 32-bittistä kokonaislukua. Täysi nimi voisi olla "iLuku5".
7. Rakennuskonventioiden noudattaminen
Lopuksi koodin rakenne on tärkeää luettavuuden parantamiseksi. Varmista, että yhdessä rivissä on vain yksi lauseke ja että jokaiselle julistukselle on oma rivinsä. Toinen seikka on tabulaattorien tai neljän tyhjän välin oikea käyttö sisennysessä.
8. Syventäminen ja lisälähteet
Jos haluat syventyä aiheeseen lisää, suosittelen virallista Microsoft-verkkosivustoa. Sieltä löydät yksityiskohtaista tietoa nimiekonventioista, rakennusohjeista ja kommenteista. Nämä tiedot ovat erittäin hyödyllisiä lähdekoodisi luettavuuden parantamiseksi.
Yhteenveto – Ymmärrä C#-nimityyppiset, koodityypit ja rakennuskonventiot
Tästä oppaasta olet saanut kattavan käsityksen erilaisista nimityyppisistä, koodityypeistä ja rakennuskonventioista C#:ssa. Nyt tiedät, kuinka nimittää luokkien nimet, menetelmät ja muuttujat asianmukaisesti ja kuinka tärkeä yhdenmukainen rakenne on ohjelmointityössäsi.
Usein kysytyt kysymykset
Kuinka aloitan luokan nimen?Luokkien nimet alkavat aina isolla kirjaimella.
Mitkä ovat Camel Case ja kuinka käytän sitä?Camel Case tarkoittaa, että jokainen sana nimeä alkaa isolla kirjaimella, esim. "YmpyräLaske".
Saanko käyttää tyhjää tilaa muuttujan nimissä?Ei, tyhjää tilaa ei sallita muuttujan nimissä.
Kuinka minun pitäisi nimetä muuttujani?Muuttujat tulisi aloittaa pikkukirjaimella ja käyttää Camel Casea.
Voinko käyttää lyhenteitä nimissä?On parempi välttää lyhenteitä sekaannusten estämiseksi.
