C# Izoh

Izoh (comment) — kompilyator e’tiborga olmaydigan, faqat inson uchun mo’ljallangan matn. Havaskor dasturchi izohni ortiqcha deb bilsa, tajribali muhandis undan kodni tushuntirish uchun foydalanadi. Katta loyihada kodni oylab keyin qaytib o’qiganingizda, aynan izohlar sizni qutqaradi.

Izoh — dastur ijrosiga ta’sir qilmaydigan, kompilyatsiya vaqtida tashlab yuboriladigan matn. C#’da bir qatorli, ko’p qatorli va XML hujjat izohlari mavjud.

Bir qatorli izoh

Bir qatorli izoh ikki qiya chiziq (//) bilan boshlanadi:

using System;

// Bu foydalanuvchini salomlaydigan dastur
Console.WriteLine("Salom, UzbekDevs!");  // izoh kod yonida ham bo'lishi mumkin

Salom, UzbekDevs!

// bilan boshlangan matn natijaga chiqmadi. Izohni kod yoniga qo’yish — bir satr nima maqsadda yozilganini tushuntirishda qulay.

Ko’p qatorli izoh

Bir necha qatorni qamrab oluvchi izoh /* va */ orasiga yoziladi:

using System;

/*
  Bu dastur mahsulot narxini hisoblaydi.
  Muallif: Farrux Sherkulov
*/
int narx = 15000;
Console.WriteLine(narx);

15000

/* ... */ orasidagi hamma narsa, necha qator bo’lishidan qat’i nazar, e’tiborga olinmaydi.

Izoh turlari

C# izohlarning uch turini beradi. Ularni jadvalda ko’ramiz:

Uchinchi tur — XML hujjat izohi — maxsus: undan avtomatik hujjat yaratiladi:

/// <summary>
/// Ikki sonni qo'shadi.
/// </summary>
static int Yigindi(int a, int b)
{
    return a + b;
}

/// bilan yozilgan izohlar <summary> kabi teglar bilan tuziladi va Visual Studio ular orqali metod haqida yordam ko’rsatadi.

Yaxshi izohning qoidasi

Muhim tamoyil: izoh kod nima qilishini emas, nega shunday qilinganini tushuntirishi kerak. narx = narx + 1; // narxga bir qo'shamiz — bu yomon izoh. narx = narx + 1; // yaxlitlashdagi kamomadni qoplash uchun — bu yaxshi izoh. Aynan shu farq havaskorni professionaldan ajratadi.

Xulosa

Bu bo’limda // bir qatorli, /* */ ko’p qatorli, /// XML hujjat izohlarini va yaxshi izohning tamoyilini ko’rib chiqdik. Izoh — kodning hujjati. Keyingi darsda ma’lumot turlariga o’tamiz.