Autor: Codenga 25.04.2023

Wiele języków programowania ma swoje konwencje nazewnicze. Określają one w jaki sposób nazywamy obiekty, klasy, zmienne itp. Dzięki temu, w pisanych przez nas programach możemy uzyskać dużą spójność kodu. Kod pisany zgodnie z przyjętymi konwencjami jest bardziej czytelny i ułatwia współpracę w zespole programistów.

W tym artykule omówimy główne konwencje nazewnicze używane w języku C#.

Notacja znana jako Pascal Case jest używana m.in do nazywania klas, metod oraz właściwości. Wszystkie słowa w nazwie powinny się zaczynać od dużych liter. Oto przykład:

  ClassName {
   
}

Ta notacja, od poprzedniej różni się tym, że pierwsze słowo rozpoczyna się od małej litery. W języku C# używamy jej m.in do nazywania pól prywatnych. Przykład:

  private int _speedMax;

Czasami do pół prywatnych dodaje się podkreślenia (“_”) na początku nazwy. Co zresztą widać na powyższym przykładzie.

Nazwy złożone z wielkich liter stosujemy dla stałych. Przykład:

  public const double PI = 3.141592653589793238;

To tyle, jeśli chodzi o najważniejsze notacje. Teraz wyjaśnimy dokładniej, w jakiej sytuacji powinno się używać danej notacji.

Popatrz na poniższe zasady. Obejmują one większość typowych elementów spotykanych w kodzie C#.

• Klasy, interfejsy i struktury: używaj PascalCase dla nazw klas, interfejsów i struktur. Dla interfejsów zaleca się dodatkowo stosowanie przedrostka "I", np. ICollectable.
• Metody: stosuj PascalCase dla nazw metod np. GetCarInfo().
• Właściwości: stosuj PascalCase dla nazw właściwości.
• Zdarzenia: stosuj PascalCase dla nazw zdarzeń.
• Pola prywatne: stosuj camelCase dla nazw pól prywatnych. Czasami dodaje się także prefiks "_" dla wyróżnienia pól prywatnych, np. _privateField.
• Pola publiczne: stosuj PascalCase dla nazw pól publicznych.
• Parametry: stosuj camelCase dla nazw parametrów.
• Stałe: stosuj WIELKIE LITERY z podkreśleniem (_) dla nazw stałych.
• Lokalne zmienne: Stosuj camelCase dla nazw zmiennych lokalnych.

Jak widzisz, mamy trzy podstawowe konwencje czyli PascalCase, camelCase oraz WIELKIE LITERY. A reszta to już kwestia zastosowania odpowiedniej konwencji do właściwych elementów w kodzie.

Popatrz teraz na przykładową klasę. Nie zawiera ona wszystkich elementów, o których przed chwilą wspominaliśmy, ale te najważniejsze są w niej obecne.

  public class Employee
{
    // Prywatne pole
    private decimal _monthlySalary;


    // Publiczna właściwość
    public string FirstName { get; set; }


    // Publiczna właściwość
    public string LastName { get; set; }


    // Publiczna właściwość tylko do odczytu
    public decimal MonthlySalary
    {
        get { return _monthlySalary; }
    }


    // Konstruktor
    public Employee(string firstName, string lastName, decimal monthlySalary)
    {
        FirstName = firstName;
        LastName = lastName;
        _monthlySalary = monthlySalary;
    }


    // Metoda obliczająca roczne wynagrodzenie
    public decimal CalculateAnnualSalary()
    {
        return _monthlySalary * 12;
    }


    // Metoda przyznająca podwyżkę
    public void ApplyRaise(decimal raisePercentage)
    {
        if (raisePercentage > 0)
        {
            _monthlySalary += _monthlySalary * (raisePercentage / 100);
        }
    }


    // Metoda zwracająca informacje o pracowniku
    public string GetEmployeeInfo()
    {
        return $"First Name: {FirstName}, Last Name: {LastName}, Monthly Salary: {MonthlySalary}";
    }
}

Zwróć uwagę na kluczowe elementy. W klasie mamy pola przechowujące informacje o pracowniku: FirstName, LastName oraz _monthlySalary. Mamy też metody np. CalculateAnnualSalary(). Wszystko zostało nazwane zgodnie w powszechnie przyjętymi konwencjami dla języka C#.

Naucz się programować w popularnym i przyjaznym języku C#. Zdobądź wartościowe umiejętności.

Dowiedz się więcej

Oczywiście cały czas trzeba pamiętać o używaniu uniwersalnych zasad, niezależnych od języka. Chodzi o takie rzeczy jak czytelność czy stosowanie jednoznacznych nazw dobrze opisujących poszczególne elementy kodu.