Компьютерде бағдарламалау кезінде, кейде басқа әзірлеушілер сіздің кодты қарап шығуы үшін ескертулер немесе түсініктемелер қалдыру қажет. Ашық көзді жоба болсын, меншікті жоба болсын, бірлесіп әзірлеушілермен және болашақ әзірлеушілермен келісу үшін түсініктемелер қажет. Түсініктемелер болмаса, код жай ғана қол жетімді болмайды.
Қадамдар
Қадам 1. Компьютерлік бағдарламаға түсініктеме берудің мақсатын түсіну
- Бұл жерде оқылатын нәрсе маңызды. Түсініктемені қараған кезде сіз бұл код емес, түсініктеме екенін білуіңіз керек.
- Түсініктеме сізге ғана емес, сіздің компьютерлік бағдарламаңыздың бастапқы кодын оқи алатын кез келген адамға пайдалы болуы керек.
Қадам 2. Өз ойыңды түсінудің қысқа, қарапайым әдісін ойла
Пікірлер өнер туындысы болудың қажеті жоқ. Олар қысқа, ұқыпты және нүктеге тура келуі керек.
Бұл түсініктеме үшін бірнеше жолды қолдануға кедергі келтірмеуі керек. Мәселе мынада, ақпарат оқырманға жетуі керек
Қадам 3. Пікірді бағдарламалау тілі берген тиісті синтаксисті қолданып жазыңыз
4 -қадам. Өзіңізден сұраңыз, сіз жазған түсініктеме жеткілікті түрде егжей -тегжейлі
Түсініктеме бастапқы кодқа қарайтын адамға бағдарламаның бұл бөлігі оны құрастырып, іске қоспай -ақ не істейтінін айта алады. Сіздің түсініктеме мұны орындай ма? Ол барлық мәліметтерді жеткізе ме?
