Konwencje nazewnictwa

Czego się dziś nauczysz

Po co komu konwencje

Konwencje to nie kaprys. To umowa, dzięki której z samego wyglądu nazwy odczytasz, czym ona jest — jeszcze zanim sprawdzisz, gdzie została zadeklarowana.

uczen.ZapiszDoPliku(nazwaPliku);
//  │        │            │
//  │        │            └── mała litera na początku → zmienna lokalna albo parametr
//  │        └── wielka litera + nawiasy → metoda, czyli coś, co się wykonuje
//  └── mała litera na początku → zmienna przechowująca obiekt

Nikt ci tego nie powiedział — po prostu tak wygląda kod w C#. Ta sama linia napisana bez konwencji (Uczen.zapiszdopliku(NazwaPliku)) niesie tę samą treść, ale trzeba się nad nią zatrzymać.

Dwa style zapisu

W C# używa się właściwie tylko dwóch sposobów sklejania wyrazów w nazwę. W obu nie ma spacji ani podkreśleń — granicę słów wyznacza wielka litera.

Spotkasz jeszcze trzeci zapis: _camelCase, czyli camelCase z podkreśleniem na początku. W C# stosuje się go do prywatnych pól klasy — wrócimy do tego w bloku o programowaniu obiektowym.

Co zapisujemy którym stylem

Co robi nazwę dobrą

Styl zapisu to dopiero połowa sprawy. Druga połowa — czy nazwa w ogóle coś mówi.

1. Nazwa ma opisywać zawartość

// ✗ Nic nie mówią
int d = 30;
string s = "Kowalski";
double x = 4.35;

// ✓ Wiadomo, o co chodzi
int dniDoWyplaty = 30;
string nazwiskoUcznia = "Kowalski";
double sredniaOcen = 4.35;

2. Nazwa metody zaczyna się od czasownika

Metoda coś robi, więc jej nazwa powinna to mówić.

Metody zwracające prawdę lub fałsz nazywa się tak, żeby czytały się jak pytanie: CzyPelnoletni(), CzyPlikIstnieje(), MaUprawnienia().

3. Nazwy logiczne piszemy twierdząco

// ✗ Podwójne zaprzeczenie — trzeba się zastanowić
bool czyNieAktywny = false;
if (!czyNieAktywny) { /* czyli... aktywny? */ }

// ✓ Czyta się wprost
bool czyAktywny = true;
if (czyAktywny) { /* jasne */ }

4. Unikaj skrótów, których nie zna cały świat

5. Bez polskich znaków w nazwach

C# je dopuszcza, ale w praktyce się ich nie używa — psują się przy przenoszeniu kodu między systemami i utrudniają wyszukiwanie. Piszemy sredniaOcen, nie średniaOcen; liczbaUczniow, nie liczbaUczniów.

Polskie znaki zostają w tekstach dla użytkownika i w komentarzach — tam są jak najbardziej na miejscu:

// Obliczamy średnią ważoną — ocena z egzaminu liczy się podwójnie
double sredniaWazona = (ocenaZajec + 2 * ocenaEgzaminu) / 3.0;
Console.WriteLine($"Twoja średnia ważona to {sredniaWazona:F2}");

Skróty i akronimy — jedna prosta reguła

Co zrobić z nazwą zawierającą skrót w rodzaju XML, HTTP czy ID? Microsoft ma na to konkretną regułę, zależną od długości skrótu.

W zapisie camelCase, czyli w zmiennych i parametrach, skrót na początku nazwy pisze się w całości małymi literami:

string xmlZawartosc;      // ✓   nie: xMLZawartosc
string htmlSzablon;       // ✓   nie: hTMLSzablon
string idUzytkownika;     // ✓   nie: iDUzytkownika
int ioBlad;               // ✓   nawet dwuliterowy, bo jest na początku

Ten sam program przed i po

Poniższy kod działa poprawnie. Problem w tym, że nikt go nie zrozumie — łącznie z autorem za miesiąc.

const double VAT_STAWKA = 0.23;

double C = 1200.0;
int IL = 3;
double W = C * IL;
double V = W * VAT_STAWKA;
double B = W + V;
bool nie_ma_rabatu = B < 500;

Console.WriteLine(B);

A teraz to samo z nazwami zgodnymi z konwencją:

const double StawkaVat = 0.23;
const double ProgRabatu = 500.0;

double cenaJednostkowa = 1200.0;
int liczbaSztuk = 3;

double wartoscNetto = cenaJednostkowa * liczbaSztuk;
double kwotaVat = wartoscNetto * StawkaVat;
double wartoscBrutto = wartoscNetto + kwotaVat;

bool czyPrzysluguRabat = wartoscBrutto >= ProgRabatu;

Console.WriteLine($"Do zaplaty: {wartoscBrutto:F2} zl");

Co dokładnie się zmieniło

Na co uważać

Zadania

const int MAX_OCEN = 5;

class uczen_szkoly
{
    public string IMIE;
    private int wiek_ucznia;

    public void oblicz_srednia() { }

    public bool nie_zdal() { return false; }
}

class HTMLGenerator { }

const int MaksymalnaLiczbaOcen = 5;

class UczenSzkoly
{
    public string Imie;
    private int _wiekUcznia;

    public void ObliczSrednia() { }

    public bool CzyZdal() { return true; }
}

class HtmlGenerator { }

bool flaga;
int licznik2;
string dane;
void Zrob();
double wartosc;

bool czyPlikZapisany;        // wiadomo, co znaczy „prawda"
int liczbaBlednychProb;      // cyfra na końcu nazwy niczego nie tłumaczy
string trescWiadomosci;      // „dane" to każdy string na świecie
void WyslijWiadomosc();      // czasownik mówi, co metoda robi
double cenaBrutto;           // „wartość" nie mówi, czego

Co trzeba zapamiętać

• PascalCase — każde słowo od wielkiej litery. camelCase — pierwsze od małej, kolejne od wielkiej.
• Reguła w jednym zdaniu: widoczne z zewnątrz od wielkiej litery, schowane w środku od małej.
• Klasy, metody, właściwości, stałe i przestrzenie nazw — PascalCase.
• Zmienne lokalne i parametry — camelCase. Prywatne pola klasy — _camelCase.
• Interfejsy zaczynają się od I: IPojazd, IZapisywalny.
• Stałych nie zapisujemy WIELKIMI_LITERAMI — to konwencja z innych języków.
• Skróty dwuliterowe wielkimi (IOException), trzyliterowe i dłuższe jak zwykłe słowo (XmlReader, HttpClient).
• Nazwa metody zaczyna się od czasownika, nazwa logiczna jest twierdząca.
• Bez polskich znaków w nazwach. W komunikatach i komentarzach — jak najbardziej.
• Zmiana nazwy w całym projekcie: Ctrl + R, Ctrl + R.