Ինչպե՞ս ստեղծել մաքուր կոդ
«Մաքուր կոդ» եզրույթը օգտագործվում է ծրագրային այն կոդը նկարագրելու համար, որը հեշտ ընթեռնելի է, հասկանալի և հեշտ պահպանվող։ Մայքլ Ֆեզըրսի խոսքերով՝ մաքուր կոդը միշտ նման է այնպիսի մասնագետի գրածին, ով իսկապես հոգ է տարել կոդի ու աշխատանքի մասին։
Սկսենք մի քանի խորհուրդներով, որոնք կօգնեն դառնալ մաքուր կոդ գրող։ Միշտ հիշեք․ մաքուր կոդ գրելն այնպիսի բան չէ, որ կարելի է հեշտությամբ սովորել։ Դա բարդ գործընթաց է, և դրա համար հարկավոր է շատ փորձել ու վարժվել, որպեսզի զարգացնեք կոդային զգացողությունը։
Նախ պետք է իմանաք, թե ինչպես գրել մաքուր կոդ, որպեսզի դառնաք մաքուր կոդ գրող։ Հեղինակը սա համեմատում է նկարչության հետ։ Լավ արվեստը վատից տարբերելու համար նախ պետք է իմանաա՝ ինչպես ստեղծել լավ արվեստ։ Նման մոտեցում է առաջարկվում նաև մաքուր կոդ գրելու համար՝ առաջին հերթին պետք է իմանաք՝ ինչպես է դա արվում։ Այդ պատճառով էլ այս հոդվածում ներկայացվող խորհուրդները կօգնեն ձեզ զարգացնել մաքուր կոդ գրելու կարողությունները։ Պետք է շարունակ փորձել, մարզվել և հետևել այս սկզբունքներին, երբ գրում եք կոդ։
Մաքուր կոդ գրելու կամ կոդը ավելի ընթեռնելի դարձնելու ժամանակ կա մի կարևոր հարց՝ ո՞ւմ համար եք դա անում։ Այստեղ երկու հիմնական դեր կա՝ նրանք, ովքեր կոդը փոփոխում են, և նրանք, ովքեր փորձում են հասկանալ՝ այդ կոդն ինչ է անում։ Այսինքն՝ գրողները և ընթերցողները։
Ուրեմն, ինչի՞ վրա պետք է կենտրոնանալ․ այն, որ կոդը հեշտ գրե՞լ, թե՞ այն, որ այն հեշտ ընթերցվի։ Սա կարևոր հարց է, և պետք է ունենաս դրա պատասխանը, որովհետև երբեմն կհայտնվես այնպիսի իրավիճակներում, երբ ինչ-որ փոփոխություն կոդում կարող է հեշտացնել գրելը, բայց միևնույն ժամանակ նվազեցնել ընթերցելիությունը կամ հակառակը։
Թեև ձեզ կարող է թվալ, որ մաքուր կոդի որևէ կանոն չեք խախտում, այնուամենայնիվ ստիպված կլինեք ընտրություն կատարել՝ ո՞րն եք ավելի կարևորում։ Հեղինակը խորհուրդ է տալիս նախընտրել ընթերցելիությունը, որովհետև երբ կոդը հեշտ ընթեռնելի է, այն ավելի արագ են հասկանում, իսկ գրողի տեսանկյունից էլ դա նշանակում է, որ կոդը հեշտ է ընկալվում։ Այսպիսով՝ ընթերցելիությունը բարելավելով դուք օգուտ եք, տալիս ինչպես գրողին, այնպես էլ ընթերցողին։
Ինչպե՞ս ճանաչել վատ կոդը
Ի՞նչպես ճանաչել վատ կոդը կամ ի՞նչն է ստիպում ձեզ զգալ, որ այն կոդը, որ կարդում եք, վատ է։ Մի քանի օգտակար խորամանկություն կներկայացնեմ։ Եթե դրանք իմանաք, կկարողանաս հեշտությամբ հասկանալ՝ վատ կոդ եք կարդում, թե ոչ։
Վատ կոդի ամենատարածված նշաններից է այն, որ սկսում եք շատ հարցեր տալ։ Եթե անընդհատ հարց եք տալիս՝ «Ի՞նչ է անում այս հատվածը», «Ի՞նչու եմ այս պարամետրերը փոխանցում», ամենայն հավանականությամբ՝ կարդում եք վատ կոդ։
Մաքուր կոդը պետք է ընթերցվի ինչպես պոեմ կամ պատմվածք։ Երբ սկսում եք կարդալ մաքուր կոդ, պետք է առանց ավելորդ ջանքերի հասկանաք դրա նպատակը։
Երկրորդ սովորական խնդիրն այն է, երբ ստիպված եք լինում կրկնակի ստուգումներ անել՝ վերադառնալ-առաջ գնալ կոդի մեջ։ Եթե ստիպված եք ամեն անգամ վերադառնալ ֆունկցիայի անունին, ուսումնասիրել դրա պարամետրերը կամ նայել ֆունկցիայի/դասի ներսում՝ սա կոչվում է «կրկնակի հայացք»։
Այդ կրկնակի հայացքը նվազեցնում է ընթերցելիությունը։ Սա լուրջ նշան է, որ դուք կարդում եք վատ կոդ։ Միշտ պետք է ձգտել նվազեցնել այդ կրկնակի նայելու անհրաժեշտությունը։
Մաքուր կոդ գրելը գրավիչ է հնչում, բայց ինչպե՞ս։
Մինչ այս հատվածը մենք որոշ բաներ սովորեցինք մաքուր կոդի մասին։ Բայց ահա գալիս է այն մասը, որին սպասում էիք․ ինչպե՞ս սկսել մաքուր կոդ գրել։
Սա լավ հարց է, բայց պատասխանելը հեշտ չէ։ Այս բաժնում ներկայացված են մի շարք խորհուրդներ, որոնք հեղինակը տալիս է՝ ձեզ օգնելու մաքուր կոդ գրող դառնալու ճանապարհին։
Միգուցե որոշ խորհուրդներ քեզ արդեն ծանոթ լինեն, կամ դրանք նախկինում փորձած լինեք՝ առանց իմանալու, որ դրանք իրականում մաքուր կոդի սկզբունքներ են։ Բայց վստահեցնում եմ՝ այստեղ կլինեն նաև նոր ու անակնկալ խորհուրդներ։
Այս բաժնի յուրաքանչյուր մասում մենք կանդրադառնանք այն հատվածներին, որոնք արժե իմանալ, ինչպես նաև կտեսնենք՝ հեղինակը ինչ տեսակետ ունի դրանց մասին։
Կոդի հետ աշխատելիս պետք է հաշվի առնել և կիրառել հետևյալ քայլերը, որպեսզի արդյունքը գոհացուցիչ և պրոֆեսիոնալ ստացվի։
Օգտագործեք անուններ, որոնք բացահայտում են իրենց նպատակը – Փոփոխականի, ֆունկցիայի կամ դասի անունը պետք է պատասխանի բոլոր հիմնական հարցերին՝ ինչու այն գոյություն ունեի, ինչ է անում և ինչպես է օգտագործվում։ Օրինակներ՝ calculate_area_rectangle(), temperature_celsius, class_car։ Այսպիսի անուններն օգնում են կոդն ավելի հեշտ և արդյունավետ կարդալ։
Խուսափեք մոլորեցնող տեղեկատվությունից – Ծրագրավորողները պետք է խուսափեն այնպիսի անուններից, որոնք կարող են սխալ պատկերացում տալ։ Օրինակ՝ եթե գրքերի բառարանի փոփոխականի անունը դնենք booksArray, այն սխալ տպավորություն կտա, որ տվյալը զանգված է, մինչդեռ իրականում այն բառարան է։ Պետք է ընտրել անուններ, որոնք ճշգրիտ ներկայացնում են բովանդակությունը։
Տարբերակումը իմաստալից ձևովարե՛ք – Անունների տարբերակումը պետք է օգնի ընթերցողին հասկանալու տարբերությունները։ Օրինակ՝ եթե սահմանում ենք երկու մեթոդ՝ getSummary(int id) և getSummaryInformation(int id, տարբերությունը չի երևում, և ընթերցողը ստիպված է նայել դրանց իրականացումը՝ հասկանալու համար՝ որն ինչ է վերադարձնում։
Օգտագործեք արտասանվող անուններ – օրինակ՝ private Date genymdhms անունը դժվար արտասանվող է։ Ավելի հարմար է օգտագործել՝ private Date StartDate։
Օգտագործեք որոնելի անուններ – երկար անունները ավելի հեշտ է գտնել, քան կարճերը։ Եթե կարճ անուններ եք օգտագործում, դրանք պետք է հստակ լինեն։ Օրինակ՝ first_fruit անունով փոփոխականը դժվար կլինի գտնել, քան first_fruit_banana, քանի որ առաջինը կարող է վերաբերել ցանկացած մրգի, մինչդեռ երկրորդը կոնկրետ է։ Այս սկզբունքը հատկապես կարևոր է, երբ օգտագործում ենք տեքստային որոնում խմբագրիչում։
Ուշադրություն դարձրեք նախածանցներին – Որքան շատ ենք կարդում կոդը, այնքան նախածանցները սկսում են «անտեսանելի» դառնալ՝ դառնալով հնացած կոդի նշան։
Խուսափեք մտքում քարտեզագրումից – Ի տարբերություն «խելացի» ծրագրավորողների՝ պրոֆեսիոնալ ծրագրավորողները հասկանում են, որ հստակությունն ամենակարևորն է։ Միշտ մտածեք հաջորդ ծրագրավորողի մասին, ով կարդալու է ձեր գրած կոդը։ Օրինակ՝ մի օգտագործեք ‘eml’՝ փոխարենը գրեք ամբողջությամբ՝ email։
Ճիշտ ընտրեք դասերի անունները – Դասերն ու օբյեկտները պետք է լինեն գոյականներ։
Զգուշորեն ընտրեք մեթոդների անունները – Դրանք պետք է լինեն բայեր։
Ընտրեք հստակություն՝ ոչ թե զվարճանք – Օրինակ՝ HolyHandsGrenade() ֆունկցիան կարող է հումորային լինել, բայց արդյո՞ք այն միանգամից հասկանալի է։ Ավելի լավ է օգտագործել՝ DeleteItems()։
Մի գաղափարի համար օգտագործեք միայն մեկ բառ – Համապատասխան ու հետևողական բառապաշարը մեծ առավելություն է ծրագրավորողների համար, որոնք աշխատում են նույն կոդի վրա։
Խուսափեք լեզվախաղերից – Մի օգտագործեք միևնույն բառը տարբեր իմաստներով։ Դա կարող է շփոթեցնել ընթերցողին։
Ավելացրեք իմաստալից համատեքստ – Քիչ անուններ կան, որոնք ինքնին իմաստ ունեն։ Դրա համար պետք է օգտագործել կոդի անուններ, որոնք համատեքստի մեջ իմաստ են ստանում՝ տեղավորելով դրանք լավ անվանակոչված դասերի, ֆունկցիաների կամ անունների տիրույթների մեջ:
Բարձր որակի ծրագրային ապահովում ստեղծելու նպատակով, որը հեշտ կլինի սպասարկել, թեստավորել և թարմացնել, անհրաժեշտ է գրել ավելի մաքուր և որակյալ կոդ։
Նախագծում տարբեր ծրագրավորողներ պետք է նույն կոդային բազայի վրա ավելացնեն տարբեր ֆունկցիոնալություններ, ուստի շատ կարևոր է, որ յուրաքանչյուր ծրագրավորող գրի մաքուր և ընթեռնելի կոդ, որը հնարավոր կլինի հասկանալ անգամ անվանման ձևավորումից։
Հետևելով վերևում ներկայացված գործնական խորհուրդներին և գրելով հստակ, կազմակերպված, ընթեռնելի և արդյունավետ կոդ՝ ծրագրավորողները կարող են ստեղծել հուսալի, մասշտաբելի և օգտագործման տեսանկյունից պարզ ծրագրեր։
