Efni.
- 01. Kóði
- 02. Skjal
- 03. Greindu
- 04. Próf
- 05. Mæla
- 06. Sjálfvirkt
- 07. Meðhöndla undantekningar
- Skref til að ná árangri
Sjónvarpsþáttur búinn til af Tuts + Premium í tengslum við net tímarit og Creative Bloq.
Með því að árangur vafra batnar ásamt stöðugri notkun nýrra HTML5 forritaskila, eykst magn JavaScript á vefnum. Samt hefur ein illa skrifuð lína af kóða möguleika á að brjóta heila vefsíðu, pirra notendur og hrekja burt hugsanlega viðskiptavini.
Hönnuðir verða að nota öll þau tæki og tækni sem þeir hafa yfir að ráða til að bæta gæði kóða þeirra til að vera fullviss um að hægt sé að treysta því að framkvæma fyrirsjáanlega í hvert skipti. Þetta er mér hugleikið efni og ég hef unnið í mörg ár að því að finna skref sem þarf að fylgja meðan á þróun stendur til að tryggja að aðeins kóði í hæsta gæðaflokki verði gefinn út.
Fylgdu þessum sjö skrefum til að bæta gæði JavaScript verkefna þinna verulega. Með þessu vinnuflæði munu færri villur eiga sér stað og allir sem gera það verða meðhöndluð tignarlega og láta notendur vafra án gremju.
01. Kóði
Byrjaðu á því að kalla fram strangan hátt ECMAScript 5 í aðgerðunum þínum með „notaðu stranga“ fullyrðingu og notaðu hönnunarmynstur mátanna, lágmarkaðu notkun alþjóðlegra breytna með því að sandkassa aðskildar kóðareiningar innan sjálfvirkrar aðgerðarlokunar, og láttu allar ytri háðir fylgja einingar skýrar og hnitmiðaðar. Notaðu aðeins rótgróin og vel prófuð bókasöfn og umgjörð þriðja aðila og hafðu aðgerðir þínar litlar og aðgreindu hvaða viðskiptarökfræði eða gögn sem er frá DOM meðferð og öðrum útsýnislagakóða.
Stærri verkefni með mörgum forriturum ættu að fylgja settum leiðbeiningum um kóðun, svo sem JavaScript stíl handbók Google, og þurfa sterkari reglur um stjórnun kóða, þ.mt strangari stjórnun á ósjálfstæði með því að nota Asynchronous Module Definition (AMD) í gegnum bókasafn eins og RequireJS, pakkastjórnun með því að nota Bower eða Jam til að vísa til sérstakra útgáfa af ósjálfstæðu skjölunum þínum, og notkun uppbyggingarhönnunar mynstra, svo sem Observer mynstur, til að auðvelda lauslega tengd samskipti milli mismunandi kóða eininga. Það er líka skynsamleg hugmynd að nota geymslukerfi kóða eins og Git eða Subversion um þjónustu eins og GitHub eða Beanstalk til að halda kóðanum þínum afrituðum í skýinu, veita möguleika á að snúa aftur til fyrri útgáfa og, fyrir lengra komna verkefni, að búa til greinar kóða til að útfæra mismunandi eiginleika áður en þeir sameinast aftur þegar þeim er lokið.
02. Skjal
Notaðu skipulagt snið fyrir athugasemdir eins og YUIDoc eða JSDoc til að skjalfesta aðgerðir svo hver verktaki geti skilið tilgang sinn án þess að þurfa að kynna sér kóða hans og draga úr misskilningi. Notaðu setningafræði Markdown til að fá ríkari athugasemdir og lýsingar í langri mynd. Notaðu tilheyrandi skipanalínutæki til að búa til sjálfkrafa skjalavefsíðu sem byggir á þessum skipulögðu athugasemdum sem eru uppfærðar með breytingum sem gerðar eru á kóðanum þínum.
03. Greindu
Keyrðu kyrrstöðu kóða-greiningartæki, svo sem JSHint eða JSLint gegn kóðanum þínum reglulega. Þessir leita að þekktum kóðunargildrum og hugsanlegum villum, svo sem að gleyma að nota stranga stillingu eða vísa til svartra breytna, og koma auga á sviga eða semikommur sem vantar. Leiðréttu öll vandamál sem tólið flaggar til að bæta gæði kóða. Prófaðu að stilla sjálfgefna valkosti fyrir verkefnateymið þitt til að framfylgja kóðunarstaðlum, svo sem fjölda rýma sem hver lína á að inndrega, hvar á að setja krullaðar sviga og notkun stakra eða tvöfaldra tilvitnana í öllum kóðaskrám.
04. Próf
Einingarpróf er lítil sjálfstæð aðgerð sem framkvæmir eina aðgerðina frá aðalkóðabasis þínum með sérstökum inntakum til að staðfesta að hún skili væntu gildi. Til að bæta sjálfstraust þitt fyrir því að kóði muni haga sér eins og búist var við skaltu skrifa einingapróf með því að nota ramma eins og Jasmine eða QUnit fyrir hverja aðgerð þína og nota bæði búnar breytur sem búist er við og óvæntar. Og ekki gleyma þessum brúnmálum!
Keyrðu þessar prófanir í mörgum vöfrum í mörgum stýrikerfum með því að nýta þér þjónustu eins og BrowserStack eða Sauce Labs sem gerir þér kleift að snúa upp sýndarvélum í skýinu eftir þörfum til prófunar. Báðar þjónusturnar bjóða upp á forritaskil sem gerir kleift að keyra einingaprófanir þínar sjálfkrafa yfir fjölda vafra samtímis og niðurstöðurnar eru sendar aftur þegar þeim lýkur. Sem bónus, ef kóðinn þinn er geymdur í GitHub geturðu nýtt þér BrowserSwarm, tæki sem keyrir sjálfkrafa einingarprófanir þínar þegar þú framselir kóðann þinn.
05. Mæla
Kóði-umfjöllunartæki eins og Istanbúl mæla hvaða kóðalínur eru framkvæmdar þegar einingaprófanir þínar keyra á móti aðgerðum þínum og tilkynna þetta sem hlutfall af heildarfjölda kóðalína. Keyrðu kóðaþekjutæki gegn einingaprófunum þínum og bættu við auka prófum til að auka umfjöllunarstig þitt í 100 prósent, sem gefur þér meira traust til kóðans þíns.
Hægt er að mæla flækjustig með Halstead flækjumælingum: jöfnum sem tölvufræðingurinn Maurice Halstead hannaði á áttunda áratug síðustu aldar sem magnar flækjustig aðgerðar eftir fjölda lykkja, greina og fallkalla sem hún inniheldur. Þegar þetta flækjustig lækkar, því auðveldara verður að skilja og viðhalda aðgerðinni og draga úr líkum á villum. Skipanalínutólið Platon mælir og býr til sjón af flóknum JavaScript kóða og hjálpar til við að bera kennsl á aðgerðir sem hægt er að bæta, en geyma fyrri niðurstöður, þannig að hægt sé að rekja gæðaframfarir með tímanum.
06. Sjálfvirkt
Notaðu verkefnahlaupara eins og Grunt til að gera sjálfvirkan skjöl, greiningu, prófanir, umfjöllun og flókið skýrslugerð, spara þér tíma og fyrirhöfn og auka líkurnar á að taka á gæðamálum sem upp koma. Flest verkfærin og prófunarumgjörðin sem lögð eru áhersla á í þessari grein hafa tengd verkefni Grunt í boði til að hjálpa þér að bæta vinnuflæði þitt og gæði kóða án þess að þurfa að lyfta fingri.
07. Meðhöndla undantekningar
Undantekningalaust, á einhverjum tímapunkti, mun kóðinn þinn varpa villu þegar hann er keyrður. Notaðu reyna ... grípa yfirlýsingar til að takast á við villur í afturkreistingum á þokkafullan hátt og takmarka áhrif á hegðun vefsins Notaðu vefsíðuþjónustu til að skrá þig aftur mistök í keyrslu. Notaðu þessar upplýsingar til að bæta við nýjum einingaprófum til að bæta kóðann þinn og uppræta þessar villur hver af annarri.
Skref til að ná árangri
Þessi sjö skref hafa hjálpað mér að framleiða einhvern kóða sem ég er stoltastur af á mínum ferli hingað til. Þeir eru frábær grunnur fyrir framtíðina líka. Skuldbinda þig til að nota þessi skref í þínum eigin verkefnum til að framleiða hágæða JavaScript kóða og vinnum saman að því að bæta vefinn skref fyrir skref.
Orð: Den Odell
Þessi grein birtist upphaflega í netblaði 249.
