Kompyuterda dasturlashda, ba'zida boshqa ishlab chiquvchilar sizning kodingizni osongina ko'rib chiqishlari uchun eslatmalar yoki sharhlar qoldirishingiz kerak bo'ladi. Ochiq manbali loyiha yoki xususiy loyiha bo'lsin, birgalikda ishlab chiquvchilar va bo'lajak ishlab chiquvchilar bilan muvofiqlashtirish uchun sharhlar kerak. Sharhlarsiz, kodni saqlab bo'lmaydi.
Qadamlar
Qadam 1. Kompyuter dasturiga izoh berish maqsadini tushuning
- O'qish qobiliyati bu erda asosiy narsa. Sharhga qaraganingizda, bu kod qatori emas, balki sharh ekanligini bilishingiz kerak.
- Sharh nafaqat sizga, balki kompyuter dasturining manba kodini o'qiy oladigan har bir kishiga ham foydali bo'lishi kerak.
2 -qadam. Fikringizni tushunishning qisqa, oddiy usulini o'ylab ko'ring
Fikrlar san'at asari bo'lishi shart emas. Ular aniq, aniq va aniq bo'lishi kerak.
Biroq, bu sharh uchun bir nechta satrlardan foydalanishni to'xtatmasligi kerak. Gap shundaki, ma'lumot o'quvchiga etkazilishi kerak
3 -qadam. Izohni dasturlash tili tomonidan berilgan tegishli sintaksis yordamida yozing
Qadam 4. O'zingizdan so'rang, siz yozgan izoh etarlicha batafsil
Sharh manba kodiga qaragan kishiga dasturning bu qismi aslida nima qilayotganini, uni kompilyatsiya qilmasdan va ishga tushirmasdan aytib berishi kerak. Sizning sharhingiz bunga erishadimi? U barcha tafsilotlarni bildiradimi?