Izohlar (comments) — bu dastur kodi ichidagi qaydlar bo'lib, Python ularni bajarish vaqtida e'tiborga olmaydi.
Izohlar orqali niyatni (intent), farazlarni (assumptions) va muhim detallarni tushuntiring.
Bir qatorli izohlar
# dan foydalaning:
# Bu izoh
print("Salom Dunyo") # Qatordagi izoh
Ko'p qatorli tushuntirishlar
Python'da alohida "ko'p qatorli comment" sintaksisi yo'q. Keng tarqalgan uslub — bir nechta # qatorlardan foydalanish:
# Bu blok nima uchun biror narsa qilishimizni tushuntiradi,
# faqat kod nima qilishini emas.
# Izohlarni qisqa va foydali qiling.
Uch tirnoqli matnlar (""" ... """) — bu satr, haqiqiy comment emas. Odatda docstring uchun ishlatiladi.
Docstring namunasi
def greet(name):
"""Return greeting text for a name."""
return f"Hello, {name}"
To'liq misol
Quyidagi skript comment'lar haqiqiy kod bilan qanday ishlashini ko'rsatadi. Faqat print() chaqiruvlari natija beradi:
# Salomlashish
print("Salom Dunyo")
# Quyidagi qator izohga olingan, shuning uchun ishlamaydi
# print("Bu chop etilmaydi")
print("Bob") # ismni chop etadi
print(123) # raqamni chop etadi
Natija:
Salom Dunyo
Bob
123
Yaxshi izoh yozish amaliyoti
Yaxshi izoh kod nima qilayotganini emas, nega qilayotganini tushuntiradi. Kodning o'zi allaqachon ko'rsatib turgan narsani qayta yozish foydasiz shovqin qo'shadi:
price = 20
# Yomon: o'z-o'zidan ravshan narsani aytadi
total = price * 2 # price'ni 2 ga ko'paytirish
# Yaxshi: sababini tushuntiradi
total = price * 2 # bayramlarda ikki barobar to'lov qo'llaniladi
print(total)
Keng tarqalgan konvensiya — tugallanmagan ishni # TODO: yoki # FIXME: bilan belgilash, shunda keyinroq uni qidirish oson bo'ladi:
# TODO: manfiy kiritmani qayta ishlash
def square_root(n):
return n ** 0.5