Izoh (kommentariy)lar
Kodga qarama-qarshi izohlar bu izohlarning yo`qligidan ham yomonroqdir. Agar kodga o`zgartirish kiritsangiz, albatta, ahr doim, izohlarni ham ularga moslab, o`zgartiring!
Izohlar yakunlangan gaplardan iboratbo`lishikerak. Agar izoh biror ibora yoki gapdan iborat bo`lsa, bu so`z dasturda qo`llanilgan o`zgaruvchining nomi bo`lmagan hollarda birinchi harfi bosh harfdan boshlanishi kerak (hech qachon o`zgaruvchi nomining registrini o`zgartirib yozmang!).
Agar izoh qisqa ko`rinishda bo`lsa, uning oxirida nuqta qo`yish shart emas. Izohlar bloki odatda bir yoki bir nechta to`laqonli gaplardan iborat abzatslardan tashkil topadi. Shuning uchun har bir gap nuqta bilan yakunlasnishi shart.
Gap tugaganida qo`yiladigan nuqtadan keyin ikkita bo`sh joy qoldiring.
Ingliz tilida gaplashmaydigan dasturchilar, iltimos, sizning dasturingizni sizning tilingizni bilmaydigan odamlar o`qimasligiga 120 % ishonchingiz komil bo`lmasa,izohlaringizni ingliz tilida yozing.
Izohlar bloki
Izohlar bloki odatda izohdan keyin joylashgan butun kod yoki uning bir qismini tushuntirish uchun qo`llaniladi hamda shu kodning o`zi bilan bir xil siljishga ega bo`lishi kerak.bunday blokning har bir satri # belgisi hamda bitta bo`sh joydan keyin boshlanishi kerak (agar izoh matnining o`zi siljishga ega bo`lmasa).
Izohlar blokining ichida abzatslar bitta # belgisidan iborat satr bilan ajratiladi.
Bunday izohlardan imkon qadar kamroq foydalanishga harakat qiling.
Bunday izoh ko`rsatma bilan bir qatorda joylashgan bo`ladi. “Satrdagi” izohlar shu satrdagi ko`rsatmadan kamida 2 ta bo`sh joy bilan ajratilishi kerak. Ular # belgisi hamda bitta bo`sh joydan keyinboshlanishi kerak.
Kod yozilgan qatordagi izohlardan foydalanish kerak emas va ular shundoq ham aniq bo`lgan holatni izohlayotgan bo`lsa, faqatgina chalg`itadi. Mana bunday ko`rinishda izoh yozmang:
x = x + 1 # Increment x
x = x + 1 # Chegarani kompensatsiyalash
Ba`zida esa, bunday izohlar foydali ham bo`lishi mumkin
Dostları ilə paylaş: |
