Programmēšana nav tikai loģikas un sintakses jautājums, bet arī skaidrības un lasāmības jautājums. Labi strukturēta lietojumprogramma uzlabo ne tikai tavu paša izpratni par kodē, bet arī atvieglo sadarbību komandā. Šajā ceļvedī tu uzzināsi, kā tu vari efektīvi strādāt C#, ievērojot nosaukumu, koda un izkārtojuma konvencijas.
Svarīgākās atziņas
Visi svarīgākie punkti, ko tu vari ņemt vērā no šī ceļveža, ir:
- Klasu nosaukumi vienmēr sākas ar lielo burtu un izmanto Camel Case.
- Metodes seko tādām pašām konvencijām kā klasumu nosaukumi.
- Mainīgie sākas ar mazo burtu un viņu vārdi arī tiek rakstīti Camel Case.
- Skaidra struktūra un lasāmība, izmantojot izkārtojuma konvencijas, ievērojami palielina tavā koda kvalitāti.
Solī pa solim ceļvedis
1. Klasu nosaukumi
Sāksim ar klasēm. Tām vienmēr jāuzsāk ar lielo burtu un tajās nedrīkst būt atstarpju. Tas novērš sintaktiskas kļūdas. Ja klases nosaukums sastāv no vairākiem vārdiem, tiek izmantota sauktā Camel Case rakstība. Pirmais vārds sākas ar lielo burtu, to seko citi vārdi, kas arī ir ar lielajiem burtiem. Piemēram, klases nosaukums varētu būt "Programm".
2. Metodes nosaukšana
Metodes nosaukšana notiek ļoti līdzīgi kā klasēm. Piemēram, metode "KreisBerechnen". Šajā gadījumā pirmais burts "Kreis" un "Berechnen" katrs sākas ar lielo burtu. Arī šeit netiek izmantoti atstarpes, lai saglabātu metodisko struktūru.
3. Metodes argumentu nosaukšana
Nosakot metodes argumentus, jāņem vērā citas noteikumi. Tie vienmēr jāuzsāk ar mazo burtu. Piemērs: kādai metodei varētu būt arguments "Arx", kas seko mazajiem burtiem.
4. Mainīgo nosaukšana
Tagad pievēršamies mainīgajiem. To nosaukumi parasti sākas ar mazo burtu, un, ja tie sastāv no vairākiem vārdiem, pārējo vārdu rakstība atkal ir Camel Case. Piemērs ir mainīgā nosaukums "zeichenAnzahl", kur "zeichen" ir mazais burts un "Anzahl" ir lielais burts, lai palielinātu lasāmību.
5. Saīsinājumi mainīgo nosaukumos
Ir ieteicams izvairīties no saīsinājumiem mainīgo nosaukumos. Tie var radīt pārpratumus. Vēl viens svarīgs aspekts ir, ka mainīgie nekad nedrīkst sākties ar ciparu. Piemērs: Tā vietā, lai nosauktu mainīgo "5Zahl", lieto "zahl5". Tas izpilda Visual Studio sintaktiskos prasības.
6. Prefikss mainīgajiem
Noderīgs triks ir pievienot mainīgo nosaukumiem prefiksu, kas norāda datu tipu. Piemēram, intīgēra mainīgajam priekšā tiek pievienots "i", kas apzīmē 32 bitu veselu skaitli. Pilnais nosaukums varētu būt „iZahl5“.
7. Pievērs uzmanību izkārtojuma konvencijām
Visbeidzot, kodu izkārtojums ir svarīgs, lai uzlabotu lasāmību. Pārliecinies, ka katrā rindā ir tikai viena instrukcija un ka katra deklarācija tiek piešķirta savai rindai. Vēl viens punkts ir pareiza tabulatoru vai četru atstarpu lietošana atkāpei.
8. Padziļinātā izpēte un papildu saites
Ja tu vēlies padziļināt šo tēmu, iesaku oficiālo Microsoft vietni. Tur tu atradīsi detalizētu informāciju par nosaukumu konvencijām, izkārtojuma vadlīnijām un komentāriem. Šī informācija ir ļoti noderīga tava avota koda lasāmībai.
Kopsavilkums – Izprast C# nosaukumu, koda un izkārtojuma konvencijas
Šajā ceļvedī tu esi ieguvis visaptverošu pārskatu par dažādām nosaukumu, koda un izkārtojuma konvencijām C#. Tagad tu zini, kā nosaukt klases, metodes un mainīgos, un cik svarīga ir vienota struktūra tavā programmēšanas darbā.
Biežāk uzdoti jautājumi
Kā sākt klases nosaukumu?Klasu nosaukumi vienmēr sākas ar lielo burtu.
Kas ir Camel Case un kā to lietot?Camel Case nozīmē, ka katrs vārds nosaukumā sākas ar lielo burtu, piemēram, "KreisBerechnen".
Vai es drīkstu izmantot atstarpes mainīgo nosaukumos?Nē, atstarpes mainīgo nosaukumos nav atļautas.
Kā man vajadzētu nosaukt savus mainīgos?Mainīgie jāuzsāk ar mazo burtu un jāizmanto Camel Case.
Vai es varu izmantot saīsinājumus nosaukumos?Labāk ir izvairīties no saīsinājumiem, lai novērstu pārpratumus.
