Երբ համակարգչով ծրագրավորում եք, երբեմն անհրաժեշտ է գրառումներ կամ մեկնաբանություններ թողնել, որպեսզի մյուս մշակողները հեշտությամբ թերթեն ձեր կոդը: Անկախ նրանից, թե դա բաց կոդով նախագիծ է, թե սեփականություն ունեցող ծրագիր, մեկնաբանություններ են անհրաժեշտ համամշակողների և ապագա հնարավոր մշակողների հետ նույնպես համակարգելու համար: Առանց մեկնաբանությունների, կոդը պարզապես չէր կարող պահպանվել:
Քայլեր
Քայլ 1. Հասկացեք համակարգչային ծրագրի մեկնաբանման նպատակը:
- Այստեղ ընթերցելիությունը ամենակարևորն է: Մեկնաբանությանը նայելիս պետք է իմանաք, որ դա մեկնաբանություն է և ոչ թե կոդի տող:
- Մեկնաբանությունը պետք է նաև օգտակար լինի ոչ միայն ձեզ, այլև որևէ մեկին, ով կարող է կարդալ ձեր համակարգչային ծրագրի աղբյուրի կոդը:
Քայլ 2. Մտածեք կարճ, պարզ միջոց ՝ ձեր ասելիքին հասնելու համար:
Մեկնաբանությունները պետք չէ արվեստի գործ լինել: Նրանք պետք է լինեն հակիրճ, կոկիկ և ուղիղ դեպի կետը:
Այնուամենայնիվ, դա չպետք է հուսահատեցնի մեկնաբանության համար բազմաթիվ տողերի օգտագործումը: Բանն այն է, որ տեղեկատվությունը պետք է հասնի ընթերցողին:
Քայլ 3. Գրեք մեկնաբանությունը `օգտագործելով ծրագրավորման լեզվի կողմից տրված համապատասխան շարահյուսությունը:
Քայլ 4. Հարցրեք ինքներդ ձեզ, արդյոք ձեր գրած մեկնաբանությունը բավականաչափ մանրամասն է:
Մեկնաբանությունը պետք է կարողանա պատմել աղբյուրին նայող մեկին, թե իրականում ինչ է անում ծրագրի այդ հատվածը ՝ առանց այն կազմելու և գործարկելու: Ձեր մեկնաբանությունն արդյո՞ք դա իրականացնում է: Արդյո՞ք այն փոխանցում է բոլոր մանրամասները:
