Կոդը ճիշտ ֆորմատավորելու մի քանի հուշում
Հեղինակ՝ Արգիշտի Եղյազարյան
HelpSystems Armenia-ում, մեր շարունակական զարգացման համար դրել էինք նպատակ՝ կատարելագործել մեր թմի կոդի ֆորմատինգը։ Ստորև կարող եք տեսնել, ինչ քայլերով կարելի է ստանալ մաքուր և ճշգրիտ կոդի ֆորմատինգ։
Formatting — ի նպատակը
Կոդի ֆորմատինգին հետևելն շատ կարևոր է ծրագրավորողի համար: Ծրագրավորողի կողմից որևէ խնդրի լուծման նպատակով գրված կոդն հնարավոր է որոշ ժամանակ հետո փոփոխվի մեկ այլ լուծումով, ինչն հնարավոր կլինի ավելի հեշտ իրագործել եթե կոդն ընթեռնելի է և ֆորմատավորված: Կոդի ֆորմատավորման մի շարք կաններին կծանոթանանք ստորև:
1. ՈՒղղահայաց ֆորմատավորում
Եկեք հասկանանք, թե որքան մեծ պետք է լինեն այն ֆայլերն, որոնցում տեղակայված են մեր կոդերը? Որքան պետք է լինի նվազագույն և առավելագույն տողերի քանակն յուրաքանչյուր source file — ի: Ուսումնասիրություններն ցույց են տալիս, որ հնարավոր է նախագծել բավականին լուրջ ծրագրեր և համակարգեր source file — երում ունենալով առավելագույնն 500 տող իսկ միջինում տողերի քանակն լինի 200: Փոքր source file — երն ավելի հեշտ է հասկանալ քան մեծ ֆայլերն: Այդ իսկ պատճառով որոշակի սահմանափակում ունենալն ուղղահայաց ֆորմատավորման դեպքում շատ կարևոր է:
2. source file — ի և թերթում տպագրված հոդվածի նմանություններն
source file — ն և նրանում գտնվող կոդն իր կառուցվածքով պետք է լինի նման թերթում տպված հոդվածի: Վերհիշենք թե ինչպիսի կառուցվածք ունի թերթի հոդվածն մտովի վերհիշելով նրանից ստացվող տեղեկատվույթյունն ընթերցելիս: Առաջին պարբերությունն մեզ տալիս է ընդհանրական տեղեկություն թե ինչի մասին է հոդվածն: Շարունակելով կարդալ հոդվածն , մենք տեղեկանում ենք նաև այլ մանրամասներին: Եվ ինչքան շատ ենք կարդում հոդվածի տողերն , այնքան շատ մանրամասների ենք մենք ծանոթանում: Նմանատիպ զգացողությունն պետք է ուղեկցի ծրագրավորողին source file — երում գրված կոդերն ՛՛կարդալիս՛՛: Մասնավորապես ֆայլի անվանումն պետք է լինի պարզ և ինֆորմատիվ այնտեղ գտնվող պարունակության վերաբերյալ: Ֆայլի ամենավերևի տողերում պետք է գտնվեն high-level կոնցեպտներն և ալգորիթմներն իսկ վերջին տողերում low-level ֆունկցիաներն և այլն:
3. Բաց տարածություներ կոդի ընթեռնելիության նպատակով
Դիտարկենք նույն կոդի երկու տարբեր ֆորմատավորում:
Նկ. 1 Կոնցեպտների տարանջատման բացակայության դեպքում կոդի ֆորմատավորումն ունի հետևյալ տեսքը
Նկ. 2 Կոդի ֆորմատավորումն կոնցեպտների տարանջատմամբ բաց տարածություններվ:
Պարզ երևում է որ երկրորդ նկարում առկա կոդն առավել ընթեռնելի է և այնտեղ առկա դատարկ տողերն մեր աչքին օգնում են հեշտությամբ տարանջատել կոնցեպտներն քան առաջին նկարում:
Փոփոխականների հայտարարում
Փոփոխականների հայտարարումն պետք է կատարել առավելագույնս մոտ իրենց օգտագործմանը: Եթե մեր հայտարարած փոփոխականն օգտագործվում է միայն ինչ որ մեթոդի իրականացման տիրությում, ապա փոփոխականի հայտարարումն պետք է կատարել նշված տիրույթի մեջ (local scope).
Class — ի փոփոխականների հայտարարում
Class — ի փոփոխականների հայտարարումն պետք է կատարել կլասի ամենավերևի մասում: Հետևելով այս կանոնին Ձեզ համար կհեշտանա փոփոխականների հայտարարումն գտնելու գործընթացն կոդի մեջ, և ստիպված չեք լինի անցնել Class — ի բոլոր տողերով:
Միմյանցից կախված ֆունկցիաներ
Երբ մի ֆունկցիայի մեջ առկա է մեկ այլ ֆունկցիայի կանչ, ապա կանչվող ֆունկցիան պետք է լինի կանչող ֆունկցիայի ներքևի մասում: (Vertical Ordering)
Հորիզոնական Ֆորմատավորում
Որքա՞ն երկար պետք է լինի մեր կոդում տողի երկարությունը:
Օպտիմալ երկարություն տողի համար ընդունված է համարել առավելագույնը 120 տառը: Սակայն միանշանակ պնդել որ տողի երկարությունն չպետք է գերազանցի նշված չափսը իհարկե սխալ կլինի: Այնուամենայնիվ տողի երկարությունն պետք է լինի այնքան, որ տողն կարդալու համար ծրագրավորողը ստիպված չլինի կատարել հորիզանական scrolling:
Indentation
Կոդի սկզբում ազատ տեղ թողնելու մի շարք կանոններ կան, որոնցից ամենատարածվածն ծրագրավորողների կողմից հետևյալն է
1. Կլասի դեկլարացիան չունի սկզբնամասում ազատ տարածք
2. Կլասի մեթոդներն ունեն մեկ աստիճան խորություն
3. Կլասի մեթոդի ներսում եղած պարունակությունն իր հերթին գրում են մեկ աստիճան խորքից
4. Եթե մեթոդն ունի բլոկներ, բլոկի պարունակությունն նույնպես պետք է ունենա մեկ աստիճան խորություն:
Ինչպես տեսանք, կա մի քանի կարևոր կետ, որոնց հետևելով կարող ենք ունենալ մաքուր և հարմար կոդի ֆորմատավորում։ Ուղահայաց ֆորմատավորման դեպքում պետք է ձգտենք չանցնել 500 տողը, իսկ հորիզոնականի դեպքում՝ 120 տառը։ Պետք է ուշադրություն դարձնենք բաց տարածություններին, փոփոխականների և Class-երի հայտարարմանը և միմյանցից կախված ֆունկցիաներին։ Դե ինչ, հետևեք այս խորհուրդներին և հեշտացրեք կոդի հետագա փոփոխություններն ու համագործակցությունը այլ ծրագրավորողների հետ։
Կարող եք հետևել մեզ սոց.ցանցերում՝ Ֆեյսբուքում, Ինստագրամում և Լինկդինում։
