Hapi i parë për të pastruar kodimin

Si zhvillues ka një theks të madh në atë që ne në industri e quajmë "Clean Coding". Kodimi i pastër është një term që i referohet praktikës së shkrimit të kodit që është i lehtë për t'u ndjekur dhe kuptuar me një shikim të shpejtë. Si zhvillues, veçanërisht zhvillues të rinj, ne priremi të shkruajmë në mënyrën tonë. Logjika jonë ndihet rehat për SHBA, por çfarë ndodh kur ne largohemi nga një projekt ose nëse i kërkojmë dikujt të rishikojë kodin tonë dhe të gjejë një gabim? Pasja e kodit të papastër i bën rishikimet e kodit një makth të plotë qoftë për recensuesin tuaj ose për veten tuaj në të ardhmen, kur t'i ktheheni atij pak kohë më vonë. Sot do të flasim për këshillën time kryesore për të filluar çdo aventurë në botën e kodimit të pastër.

Strategjia

Le të shqyrtojmë për një sekondë parimin THAT. Për ata që janë më të rinj në industrinë e teknologjisë, DRY është një akronim për "Mos e përsërit veten!". Imagjinoni pse e kanë shkruar DRY për të përshkruar kuptimin e saj dhe merrni parasysh sa vijon. Sa e rëndë është një veshje kur është e lagur? Më e rëndë apo jo? Ka shumë 'junks' shtesë (ose në këtë rast, ujë) që rëndon veshjen tuaj dhe kjo e bën atë të pakëndshme për t'u përdorur. Mendoni për kodin që nuk është i tharë në të njëjtën mënyrë. Kodi juaj është më i rëndë, i mbushur me "junk" dhe krijon një produkt të përfunduar të ngathët. Me siguri nuk do të dëshironit të vishni një këmishë të lagur (por nuk do të flas për të gjithë!), dhe e njëjta gjë vlen edhe për përdorimin e kodit që nuk është DRY. Kodimi i pastër është më i lehtë për të filluar shkrimin nëse filloni fillimisht me principalin DRY, kështu që sot ne do ta shqyrtojmë atë në detaje.

Pse THATË?

Kur mësojmë për herë të parë se si të kodojmë, priremi të fillojmë duke shkruar DIÇKA që e bën kodin të funksionojë siç duhet? Sa herë ju kujtohet se keni shkruar dy projektet tuaja të para dhe keni abuzuar me funksionalitetin e kopjimit dhe ngjitjes? Jeni kthyer ndonjëherë për të lexuar kodin e dy projekteve tuaja të para? Te dhemb apo jo? A shihni blloqe të gjata të kodit të përsëritur që ngadalësojnë aftësinë tuaj për të interpretuar se cili ishte qëllimi juaj përfundimtar në atë bllok? A janë disa nga funksionet tuaja që përfshijnë mbi 50 rreshta kodi me logjikë kopjimi dhe ngjitje nga zonat e mëparshme në projekt? Nëse po, atëherë le të eksplorojmë përdorimin e DRY dhe të mendojmë pse kjo strategji është një hap i parë i përsosur për të pastruar kodin tuaj.

Si të përdorni DRY

Le të themi se keni disa funksione që ju nevojiten për të ekzekutuar në shumë vende, si mbledhja e të dhënave nga ruajtja lokale dhe analizimi i tyre. Unë do të përdor pseudo-kodin këtu dhe do të hartoj logjikën në asnjë gjuhë specifike:

Shembull: [Qasuni në hapësirën ruajtëse lokale dhe ruajeni atë] › [Parzoni të dhënat dhe bëjini të lexueshme në kod]

Më sipër ne e kemi këtë kod të shkruar për të marrë të dhënat tona të ruajtjes lokale dhe për t'i analizuar ato në kod që mund ta përdorim për pjesë të tjera të aplikacionit tonë. E madhe! Tani dëshironi të përdorni këtë kod në një funksion që lejon të themi se thjesht duhet të shfaqim një numër:

funksioni displayNumber() › [Qasuni në hapësirën lokale të ruajtjes dhe ruajeni atë] › [Androjini të dhënat dhe bëjini të lexueshme në kod] › [Shfaq numrin]

Mirë mirë. Kështu që ne morëm draftin tonë dhe e përdorëm për të nisur këtë funksion dhe shohim që funksionon. Tani na duhet përsëri ajo metodë sepse na duhen ato të dhëna për të shfaqur disa karta:

funksioni displayCards() › [Qasuni në hapësirën lokale të ruajtjes dhe ruajeni atë] › [Të analizoni të dhënat dhe bëjeni të lexueshme në kod] › [Shfaq Kartat]

Vini re se si e kopjuam logjikën përsëri edhe në këtë funksion. Shumë prej nesh mund ta dinë ta bëjnë këtë kur filluam për herë të parë dhe ndoshta nuk ndalet këtu. Mund të na duhet ajo logjikë përsëri dhe përsëri, kështu që ne e shkruajmë atë përsëri në një funksion tjetër dhe kështu me radhë, e kështu me radhë — Mund ta shihni vetëm në shembujt e mi se po e bën tekstin tim mjaft të gjatë dhe të përsëritur. Mund të ishte edhe më keq nëse do të përdorja kodin më të gjatë se disa kode për të hyrë në ruajtje.

Pra, si ta pastrojmë atë?

Marrja e të dhënave, shkrimi i tyre një herë dhe ruajtja e tyre në diçka për t'i telefonuar më vonë është një mënyrë e shkëlqyer për ta arritur këtë. Konsideroni të shkruani një variabël ose funksion që ruan të dhënat.

variabli storageData = [Qasuni në hapësirën ruajtëse lokale dhe ruajeni atë] › [Parzoni të dhënat dhe bëjini të lexueshme në kod]

Tani mund të marrim storageDatadhe t'i kalojmë në funksionet tona. Në këtë mënyrë, kur lexojmë funksionet tona, ne tashmë e dimë se nga kanë ardhur të dhënat e ruajtjes, dhe kjo e bën kodin tonë më të shkurtër dhe në mënyrë dramatike më të lexueshëm. Le të kthehemi te shembulli ynë i funksionit të numrit të ekranit. Tani mund të duket diçka si kjo:

funksioni displayNumber(storageData) › [Display Number]

Tani po i ruaj të dhënat në fillim të kodit tim dhe po e kaloj atë variabël në funksionin tim. Kjo e bën kodin tonë më profesional, më estetik dhe më të lehtë për t'u ndjekur. Shihni se si kjo është shumë më e lehtë për t'u kuptuar dhe shumë më e lehtë për t'u shkruar gjithashtu? Nuk ka më lëvizje nëpër kodin duke kërkuar logjikën dhe kopjoni dhe ngjitni bllokun në çdo zonë që ju nevojitet. E madhe!

Përmbledhje

Ne folëm kryesisht për parimet bazë të DRY dhe përdorëm një shembull të vogël me peshë të lehtë se si ta përdorni atë në kodin tuaj. Për shembuj të DRY, ndjehuni të lirë të shikoni ndonjë nga projektet e mia të fundit në Github në https://github.com/AKeeganDev.

Duke gjetur mënyra për të shkruar blloqe kodi një herë, duke e ruajtur atë dhe duke e aksesuar atë kur është e nevojshme, jo vetëm që përmirëson cilësinë dhe zgjerueshmërinë e kodit tuaj, por vetja juaj e ardhshme do t'ju falënderojë më vonë kur t'i ktheheni këtij kodi javë, muaj ose vite nga tani dhe përpiqu të kuptosh atë që ke shkruar.

Nëse ju pëlqeu ky artikull dhe dëshironi që unë të shkruaj më shumë këshilla fillestare si kjo. Ju lutem më kontaktoni për të më treguar se si kam bërë dhe gjithashtu mos ngurroni të sugjeroni një temë që mund të mbuloj.

Faleminderit që lexuat artikullin tim të parë të këshillës së programimit!