Izohlar

Nima uchun izohlardan foydalanish kerak?

Yaxshi izohlar kodni tushunarli va qo‘llab-quvvatlashga qulay qiladi.

Izohlar yordamida quyidagilarni qilish mumkin:

• Murakkab mantiqni tushuntirish
• Funksiyalar, sinflar yoki fayllarning maqsadini tavsiflash
• Yaxshilanishi kerak bo‘lgan qismlarni belgilash
• Boshqalar bilan hamkorlikni osonlashtirish
• Qatorlar yoki bloklarni vaqtincha o‘chirib qo‘yib, koddagi xatolarni tuzatish (debug)

Izoh turlari

Ko‘pchilik dasturlash tillari izohlarning bir nechta turini qo‘llab-quvvatlaydi:

1. Bir qatorli izohlar

Qisqa tushuntirishlar yoki qaydlar uchun ishlatiladi.

Yoki butun qator sifatida:

//this line is a comment
print("Hello");

yoki qator oxirida:

print("Hello"); //this is a comment

2. Ko‘p qatorli izohlar

Uzunroq tushuntirishlar uchun ishlatiladi. Sintaksisi tilga qarab farq qiladi.

/*This is a comment
that spans over
multiple lines*/
print("Hello");

3. Qator ichidagi izohlar

Izohlar kod qatorining ichida ham kelishi mumkin. Ko‘p qatorli izohlarni qo‘llab-quvvatlaydigan tillarda izohni ko‘rsatma (operator) o‘rtasiga joylashtirishingiz mumkin.

Bu ba’zan test uchun qiymat yoki mantiqni tezda o‘zgartirishda ishlatiladi.

firstname = /*"John"*/"Jane";
print("Hello " + firstname);

Eslatma: Bu usul Python tilida ishlamaydi, chunki Python ko‘rsatmalar ichidagi blok izohlarni qo‘llab-quvvatlamaydi.

Turli tillardagi izohlar

Qator ichidagi izohlar

Qator ichidagi izohlar — bu kod bilan bir qatorda yoki hatto kod qatorining ichida keladigan izohlar. Ular ko‘rsatmaning muayyan qismini tushuntirish yoki test va nosozliklarni tuzatish uchun kodni tezda o‘zgartirishda foydali.

• Qator o‘rtasidagi (mid-line) izohlar: Ko‘rsatma ichiga joylashtiriladi.
• Qator oxiridagi izohlar: Ko‘rsatmadan keyin uning maqsadini tushuntirish uchun joylashtiriladi.

let x = 10;
let y = /*5*/ 7;
let z = x + y;
console.log(z); // outputs 17

int x = 10;
int y = /*5*/ 7;
int z = x + y
System.out.println(y); // Output: 17

int x = 10;
int y = /*5*/ 7;
int z = x + y;
printf("%d\n", y); // Output: 17

int x = 10;
int y = /*5*/ 7;
in z = x + y;
std::cout << y << std::endl; // Output: 17

<p>Hello <!-- John --> Jane!</p> <!-- Outputs 'Hello Jane' -->

SELECT * FROM Customers
WHERE city = /*'London'*/ 'Berlin'; // Returns all customers from Berlin

Izohlardan nosozliklarni tuzatishda foydalanish

Izohlar faqat hujjatlashtirish uchun emas — ular nosozliklarni tuzatishda (debugging) ham kuchli vosita bo‘la oladi. Koddagi muammoni izlayotganda muammoni ajratib olish yoki ma’lum kod bajarilishining oldini olish uchun qatorlar yoki bloklarni vaqtincha "izohga aylantirib" (comment out) qo‘yishingiz mumkin.

• Kodni izohga aylantirish: Kodingiz qismlarini o‘chirib tashlamasdan faolsizlantiring, shunda ularni keyinroq osongina tiklash mumkin bo‘ladi.
• O‘zgarishlarni xavfsiz sinash: Asl kodni namuna sifatida izoh ko‘rinishida saqlab qolgan holda yangi mantiqni sinab ko‘ring.
• Xatolarni ajratib olish: Qismlarni izohga aylantirib, xatolar qayerda yuz berayotganini aniqlashtirishingiz mumkin.

# Debugging by commenting out a line
x = 10
y = 0
# y = 5
result = x + y
print(result)

// Debugging by commenting out a line
let x = 10;
let y = 0;
// y = 5;
let result = x + y;
console.log(result);

// Debugging by commenting out a line
#include 
using namespace std;
int main() {
  int x = 10;
  int y = 0;
  // y = 5;
  int result = x + y;
  cout << result << endl;
  return 0;
}

// Debugging by commenting out a line
public class Main {
  public static void main(String[] args) {
    int x = 10;
    int y = 0;
    // y = 5;
    int result = x + y;
    System.out.println(result);
  }
}

<!-- Debugging by commenting out a line -->
<!-- <p>This paragraph is temporarily hidden for debugging</p> -->
<p>Hello, world!</p>

-- Debugging by commenting out a line
-- SELECT * FROM Cutomers;
SELECT * FROM Products;

# Debugging by commenting out a line
# rm important_file.txt
echo "Safe for now!"

Maslahat: Kodingizni toza va qo‘llab-quvvatlashga qulay saqlash uchun uni yakunlashdan oldin nosozliklarni tuzatish uchun yozilgan izohlarni olib tashlashni yoki yangilashni unutmang.

Izohlar uchun eng yaxshi amaliyotlar

• Aniq va qisqa izohlar yozing
• Izohlarni kodingizga mos ravishda dolzarb holda saqlang
• O‘z-o‘zidan ravshan narsalarni yozmang (x += 1 uchun "x ni 1 ga oshirish" deb yozishdan saqlaning)
• Izohlardan faqat nima qilinayotganini emas, nima uchun qilinayotganini tushuntirish uchun foydalaning
• Eskirgan yoki chalg‘ituvchi izohlarni olib tashlang

Xulosa

Izohlar kodingizni o‘qilishi oson, qo‘llab-quvvatlashga qulay va hamkorlikda ishlashga yaroqli qilish uchun muhim vosita. Ulardan oqilona foydalaning!