Kotlin 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. Kotlin’da bir qatorli va ko’p qatorli izohlar mavjud.

Bir qatorli izoh

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

fun main() {
    // Bu foydalanuvchini salomlaydigan dastur
    println("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:

fun main() {
    /*
      Bu dastur mahsulot narxini hisoblaydi.
      Muallif: Farrux Sherkulov
    */
    val narx = 15000
    println(narx)
}

15000

/* ... */ orasidagi hamma narsa, necha qator bo’lishidan qat’i nazar, e’tiborga olinmaydi. Kotlin’da ko’p qatorli izohlar ichma-ich joylashishi ham mumkin.

Izoh turlari

Kotlin izoh shakllarini jadvalda jamlaymiz:

Uchinchi tur — KDoc — funksiya va sinflarni hujjatlashda ishlatiladi, undan avtomatik hujjat yaratiladi.

Kodni vaqtincha o’chirish

Izohning amaliy foydasi — kodni o’chirmasdan turib, vaqtincha ishlamas qilish. Bu xatoni izlaganda juda qo’l keladi:

fun main() {
    val ism = "Master Sherkulov"
    // println("Bu qator hozir ishlamaydi")
    println(ism)
}

Master Sherkulov

Ikkinchi println izohga aylantirildi, shuning uchun faqat oxirgisi ishladi. Kodni butunlay o’chirmasdan sinash — professional ish uslubi.

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, /** */ KDoc izohlarini va yaxshi izohning tamoyilini ko’rib chiqdik. Izoh — kodning hujjati. Keyingi darsda ma’lumot turlariga o’tamiz.