Ärge nõustuge arendama seda, mida te ei mõista.

Alates 2018. aasta algusest olen ma juhtinud arendusmeeskonda – kuidas iganes seda nimetada, aga oluline on see, et vastutan täielikult ühe mooduli ning kõigi arendajate eest, kes selle kallal töötavad. See positsioon avab mulle uue vaatenurga arendusprotsessile, kuna olen kaasatud rohkematesse projektidesse ja osalen aktiivsemalt otsuste tegemises. Hiljuti, tänu nendele kahele asjaolule, olen ma ootamatult mõistnud, kui suurt mõju omab arusaam koodile ja rakendusele.

Mõte, mida soovin edastada, seisneb selles, et koodi (ja lõpp-produkti) kvaliteet on tihedalt seotud sellega, kui teadlikud on inimesed, kes projekteerivad ja kirjutavad koodi, sellest, mida nad tegelikult teevad.

Te võite justkui mõelda: "Aitäh, kapten. Loomulikult oleks hea aru saada, mida üldse kirjutad. Vastasel juhul võiksime sama hästi palgata grupi ahve, et nad lihtsalt juhuslikult klahvidele toksiksid, ja sellega rahul olla." Ja te olete täiesti õiged. Seega, ma oletan, et te mõistate, et on vajalik üldine arusaam sellest, mida teete. Seda võiks nimetada arusaamise nulltasemeks, ja me ei hakka seda põhjalikult käsitlema. Põhjalikult käsitleme, mida täpselt on vaja mõista ja kuidas see mõjutab otsuseid, mida te iga päev teete. Kui ma oleksin neid asju ette teadnud, oleks see mind vabastanud massilisest ajaraiskamisest ja kahtlasest koodist.

Kuigi allpool te ei näe ükski koodirida, pean siiski oluliseks, et kõik, mida siin öeldakse, on kvaliteetse ja väljendusrikka koodi kirjutamise jaoks väga oluline.

Esimene arusaamistase: Miks see ei tööta?

Selle taseme saavutavad arendajad tavaliselt oma karjääri varases etapis, mõnikord isegi ilma välise abita — vähemalt minu tähelepanekute kohaselt. Kujutage ette, et olete saanud veateate: mõni rakenduse funktsioon ei toimi, seda tuleb parandada. Kuidas te käitutate?

Tavapärane skeem on järgmine:

1. Leida koodilõik, mis põhjustab probleemi (kuidas see toimub, on eraldi teema; seda käsitlen oma raamatus vananenud koodi kohta)
2. Teha selles lõigus muudatused
3. Veenduda, et viga on parandatud ja regressive vigu ei ole tekkinud

Nüüd keskendume teisele punktile — muudatuste tegemisele koodis. On kaks lähenemist: esiteks, süveneda praeguse koodi toimimisse, tuvastada viga ja see parandada. Teiseks: liikuda pimesi — lisada näiteks +1 tingimuslikku operaatorisse või tsüklisse, vaadata, kas funktsioon toimib nõutud stsenaariumis, proovida siis veel midagi ja nii edasi lõputult.

Õige lähenemine on esimene. Kuidas selgitab oma raamatus Code Complete Steve McConnell (soovitan seda raamatut kindlasti), iga kord, kui me koodis midagi muudame, peame olema võimelised kindlalt ennustama, kuidas see rakendusele mõjub. Tsiteerin mälust, kuid kui vea parandamine ei toimu nii, nagu sa ootasid, peaks see sind tõsiselt muretsema, peate küsimise alla seadma oma kogu tegevuskava.

Kokkuvõttes, et teostada korralikku vea parandamist, mis ei halvendaks koodi kvaliteeti, tuleb mõista nii kogu koodi struktuuri kui ka konkreetse probleemi allikat.

Teine mõistmise tase: Miks see töötab?

See tase on palju vähem intuitiivselt mõistetav kui eelmine. Olles veel algaja arendaja, õppisin selle ometi oma juhilt, hiljem olen korduvalt seda sama asja selgitanud algajatele.

Seekord kujutame ette, et olete saanud kohe kaks vea aruannet: esimene puudutab stsenaariumi A, teine stsenaariumi B. Mõlemal juhul on midagi valesti. Seega hakkate esmalt tegelema esimese veaga. Järgides esimesel tasandil arusaamiseks välja töötatud põhimõtteid, uurite põhjalikult koodi, mis on seotud probleemiga, selgitades välja, miks see paneb rakenduse käituma just nii stsenaariumis A, ning teete mõistlikud muudatused, mis annavad soovitud tulemuse. Kõik läheb suurepäraselt.

Seejärel liigute stsenaariumisse B. Korratakse stsenaariumi, et proovida viga esile kutsuda, kuid — üllatus! — nüüd töötab kõik nagu peab. Oma arvamuse kinnitamiseks tühistate muudatused, mis tehti vea A lahendamise käigus, ja viga B ilmub tagasi. Teie vea parandamine lahendas mõlemad probleemid. Õnnestus!

Te ei oodanud seda üldse. Leidsid viisi, kuidas vea stsenaariumi A parandada, ja pole aimugi, miks see ka stsenaariumi B puhul töötas. Sel hetkel on suur kiusatus järeldada, et mõlemad ülesanded on edukalt täidetud. See tundub loogiline: mõte oli ju vigade kõrvaldamises, eks? Kuid töö pole veel läbi: pead välja selgitama, miks sinu tegevused parandasid vea stsenaariumis B. Miks? Sest see võib töötada vale põhimõttel, ja siis pead otsima uut lahendust. Siin on paar näidet sellistest olukordadest:

• Kuna lahendus ei olnud konkreetselt suunatud vea B lahendamisele, arvestamata kõiki tegureid, oled sa ehk tahtmatult purustanud funktsiooni C.
• Pole välistatud, et kuskil peidab end veel kolmas bugin, mis on seotud sama funktsiooniga, ja su bugifiz maksab süsteemi korrektse töö stsenaariumis B sellele. Praegu näeb kõik hea välja, kuid ühel kaunil päeval märgatakse seda kolmandat bugin ja see parandatakse. Siis tekib stsenaariumis B taas viga, ja oleks hea, kui see oleks vaid seal.

See, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see, see.

Kolmas arusaamistasand: Miks see töötab?

Viimane arusaam, millega ma hiljuti kokku puutusin, on just see, ja ilmselt oleks mul selle mõistmine andnud veelgi rohkem eeliseid, kui ma oleksin selleni varem jõudnud.

Selguse huvides võtame näite: teie moodul peab olema ühilduv funktsiooniga X. Teil ei ole funktsiooniga X eriti lähedast tutvust, kuid teile on öeldud, et selle ühilduvuse tagamiseks peate kasutama raamistikku F. Teised moodulid, mis integreeruvad X-iga, toimivad just selle raamistiku kaudu.

Teie kood ei ole oma elu esimesest päevast alates kunagi olnud seotud raamistikuga F, seetõttu on selle rakendamine tõeliselt keeruline. See võib põhjustada tõsiseid tagajärgi mõne mooduli komponendi jaoks. Sellegipoolest sukeldute sügavale arendusse: kirjutate nädalate kaupa koodi, testite, käivitate pilootversioone, saad foorumitelt tagasisidet, parandate regressioonivigu, avastate ettenägematuid komplikatsioone, ei pea algselt kokkulepitud tähtaegadest kinni, kirjutate veel natuke koodi, testite, saade tagasi ja parandate regressioonivigu — kõik selleks, et rakendada raamistikku F.

Ja mingil hetkel taipate järsku — või võib-olla kuulete kedagi ütlevat — et raamistik F ei pruugi teile funktsiooni X ühilduvust pakkuda. Võib-olla on kõik see aeg ja vaev pandud täiesti valele asjale.

Kordagi projektiga töötades juhtus midagi sarnast. Miks see nii läks? Sest ma ei mõistnud hästi, mis on funktsiooni X olemus ja kuidas see seondub F raamistikuga. Kuidas oleksin pidanud toimima? Oli vaja küsida inimeselt, kes antud ülesande määrab, selgelt selgitada, kuidas kavandatud tegevuskava viib soovitud tulemuseni, selle asemel, et lihtsalt korrata seda, mis tehtud teiste moodulitega, või uskuda, et see on vajalik funktsiooni X toimimiseks.

Selle projekti kogemus õpetas mind keelduma arendusprotsessi alustamisest, kuni meil on selge arusaam, miks meid palutakse teatud tegevusi teha. Otseselt keelduma. Kui saad ülesande, on esimene impuls - haarata sellest kohe kinni, et mitte aega raisata. Kuid poliitika „peatame projekti, kuni mõistame kõiki detaile“ võib tuvastatud raisatud aja kärpida terve hulga võrra.

Isegi kui keegi üritab teid survet avaldada ja sundida teid tööle, kuigi te ei mõista, miks see vajalik on – vastanduge sellele. Esiteks selgitage välja, millise eesmärgi nimel teile selline ülesanne antakse, ja otsustage, kas see on õige tee eesmärgi saavutamiseks. Ma pidin seda kõike valusa kogemuse kaudu õppima – loodan, et minu näide võib nende elu, kes seda loevad, kergemaks teha.

Neljas tasand arusaamisest: ???

Programmeerimises on alati midagi uut õppida ja usun, et olen puudutanud vaid teema arusaamise pindmisi kihte. Milliseid teisi arusaamiste tasandeid olete aastate jooksul koodiga töötades avastanud? Milliseid otsuseid olete teinud, mis on positiivselt mõjutanud koodi ja rakenduse kvaliteeti? Millised otsused osutusid valeiks ja andsid teile väärtuslikke õppetunde? Jagage oma kogemusi kommentaarides.

Allikas: habr.com