Nasihu don Rubuta Lambar da Za a Iya Kulawa
Rubuta lambar ba wai kawai game da sa shirin ya "gudu" ba ne. A aikace, ana ɓatar da wani ɓangare mai yawa na lokacin haɓaka software ana karantawa, gyarawa, da haɓaka lambar da ke akwai - ko ta naka ko ta wani. Saboda haka, ikon rubuta lambar da za a iya kiyayewa ƙwarewa ce mai mahimmanci ga kowane mai shirye-shirye. Lambar da za a iya kiyayewa tana rage farashin gyarawa, tana hanzarta ƙara fasali, tana rage kurakurai, kuma tana sa haɗin gwiwar ƙungiya ya fi tasiri. Ga wasu shawarwari masu amfani don rubuta lambar tsabta, bayyananne, da dorewa.
1. Ba da fifiko ga sauƙin karatu fiye da "wayo"
Lambar da ta yi "wayo" sau da yawa tana da wuyar fahimta. Misali, rubuta layin lamba mai takaitacciyar hanya na iya zama mai kyau, amma yana iya zama mai rikitarwa idan aka sake karantawa. Zaɓi mafita mai haske, koda kuwa ta ɗan daɗe. Sauƙin karantawa jari ne: za ka iya rubuta lambar sau ɗaya kawai, amma za ka karanta ta sau da yawa.
Misali, maimakon sanya ayyuka da yawa a cikin magana ɗaya, raba su zuwa matakai tare da sunaye masu ma'ana masu canzawa. Wannan yana taimaka wa mai karatu ya fahimci manufar shirin ba tare da yin zato ba.
2. Yi amfani da suna mai haske da daidaito
Sunayen masu canzawa, ayyuka, da kuma ajin su ne "layin farko na takardu" na lambar ku. Sunaye masu kyau ya kamata su bayyana rawar da suke takawa ko manufarsu, ba kawai tsarin bayanan su ba. Misali, `userList` ya fi `ul` bayani, kuma `calculateTotalPrice()` ya fi bayyana fiye da `ctp()`.
Baya ga haske, sunaye ya kamata su kasance daidai. Idan kuna amfani da camelCase don masu canji, ku tsaya tare da shi a duk tsawon aikinku. Don azuzuwan, yi amfani da PascalCase idan wannan shine yanayin yaren da kuka fi so. Daidaito yana sa lambar ta ji iri ɗaya kuma yana rage nauyin tunani lokacin karatu.
3. Yi amfani da ƙa'idar "Nauyi Guda Ɗaya"
Ɗaya daga cikin manyan abubuwan da ke haifar da wahalar kiyaye lambar shine ayyuka ko azuzuwan da ke yin abubuwa da yawa. Ka'idar Nauyin Ɗaya ta nuna cewa ya kamata sashin lambar ya kasance yana da babban nauyi ɗaya kawai. Aiki mai tsayi da yawa yawanci alama ce da ke nuna cewa yana buƙatar a raba shi.
Misali, aikin "tsarin biyan kuɗi" wanda ke tabbatar da shigarwa a lokaci guda, yana ƙididdige farashi, yana tuntuɓar ƙofar biyan kuɗi, kuma yana aika imel zai yi wahalar gwadawa kuma yana da wahalar canzawa. Ta hanyar rarraba shi zuwa ayyuka daban-daban (tabbatarwa, lissafi, biyan kuɗi, sanarwa), zaku iya yin canje-canje ga ɓangare ɗaya ba tare da karya sauran ba.
4. A guji yin kwafi (BUSHEWA), amma kada a yi shi fiye da kima.
BUSHEWA (Kada Ka Maimaita Kanka) muhimmin ƙa'ida ne: idan ka kwafi toshe lambar iri ɗaya sau da yawa, ƙaramin canji zai buƙaci ka gyara komai. Wannan yana da saurin kuskure. Mafita ita ce a cire maimaitawar dabaru zuwa cikin aiki ko module.
Duk da haka, yana da mahimmanci a tuna cewa guje wa kwafi fiye da kima na iya cutar da karatu. Idan lambobi biyu suka yi kama da juna amma a zahiri suna da yanayi daban-daban, tilasta "raba bayanai" na iya sa lambar ta zama mai rikitarwa. Nemo daidaito: refactor lokacin da kwafi yake da ma'ana kuma yana da yuwuwar canzawa tare.
5. Ƙirƙiri tsarin aiki mai kyau
Tsarin babban fayil mai haske yana tasiri ga sauƙin kulawa. Rarraba fayiloli ta hanyar fasali ko module, ba kawai ta nau'in fayil ba, musamman ga manyan ayyuka. Tsarin da ya dace yana sauƙaƙa wa sabbin shiga fahimtar tsarin aikin.
Misali, maimakon sanya dukkan abubuwan UI ɗinku a cikin babban fayil ɗaya, kuna iya raba su ta hanyar fasali: `auth/`, `profile/`, `checkout/`, da sauransu. Wannan hanyar tana taimakawa aikinku ya girma yayin da yake girma.
6. A takaita sarkakiya kuma a sauƙaƙa gudanar da shi cikin sauƙi.
Lambar da ke cike da maganganun if-else, sharuɗɗa da yawa, da keɓancewa na musamman sau da yawa yana da wahalar kiyayewa. Yi ƙoƙarin sauƙaƙa tunaninka. Za ka iya amfani da dabaru kamar dawowa da wuri don rage yin gida, ko kuma motsa dabaru masu rikitarwa zuwa ƙananan ayyuka waɗanda za a iya sanya musu suna daidai.
Idan wani aiki yana da sigogi da yawa, yana kuma nuna rikitarwa. Yi la'akari da amfani da abin saitawa (ko tsarin bayanai) don tsara sigogi da kyau da kuma sauƙaƙa faɗaɗa su.
7. Rubuta sharhin da aka yi niyya
Sharhi ba madadin lambar sirri ba ne. Idan kana buƙatar bayyana "abin da lambar ke yi," wataƙila yana buƙatar a ƙara karanta shi. Duk da haka, sharhi har yanzu yana da amfani wajen bayyana "dalilin" da yasa ake yin wani abu, musamman idan akwai shawarwarin ƙira, iyakokin tsarin, ko takamaiman dalilan kasuwanci.
Misalan kyawawan maganganu sun haɗa da bayyana dalilin da yasa ake amfani da wani takamaiman tsari saboda ƙarancin aiki, ko kuma dalilin da yasa dokar tabbatarwa ta zama abin mamaki saboda tana bin ƙa'ida. Ta wannan hanyar, wasu ba za su "gyara" lambar ba kuma su karya mahimman dabaru.
8. Yi amfani da tsarin lamba da jagororin salo
Tsarin rubutu mai daidaito yana sa lambar ta yi kama da ta ƙwararru kuma mai sauƙin karantawa. Yi amfani da matattarar rubutu da masu tsara rubutu ta atomatik idan akwai (misali, ESLint + Prettier don JavaScript, Baƙi don Python, ko gofmt for Go). Tare da waɗannan kayan aikin, ƙungiyoyi ba sa damuwa game da tazara da ƙofa, domin komai ana sarrafa shi ta atomatik.
Jagororin salo kuma suna taimakawa: ko za a yi amfani da ambato ɗaya ko biyu, yadda ake sanya sunayen fayiloli, lokacin da za a karya layuka masu tsawo, da sauransu. Ƙananan ƙa'idodi irin waɗannan na iya yin babban canji a cikin dogon lokaci.
9. Rubuta gwaje-gwaje don kiyaye amincewa yayin sake gyarawa.
Lambar da za a iya kiyayewa ba wai kawai tana da tsabta ba, har ma tana da aminci don canzawa. Gwaje-gwajen atomatik (gwaje-gwajen raka'a, gwaje-gwajen haɗin kai) suna tabbatar da cewa canje-canjenku ba sa karya halayen da aka kafa. Ba tare da gwaje-gwaje ba, mutane suna jin tsoron inganta lambar saboda haɗarin kurakurai da ba a gano ba.
Fara da muhimman sassan: ayyukan lissafin farashi, ƙa'idodin rangwame, tabbatarwa, ko kuma kayan aiki da ake yawan canzawa. A tsawon lokaci, ɗaukar gwaji zai ƙaru kuma ya samar da kariya mai ƙarfi daga koma-baya.
10. Yi gyaran fuska akai-akai kuma cikin aunawa
Kulawa tsari ne mai ci gaba. Gyara ba yana nufin "sake rubuta komai ba," amma ƙananan gyare-gyare ne waɗanda ke inganta ingancin lambar ba tare da canza halayenta ba. Shirya gyara lokacin da ka taɓa wani sashe na lambar: gyara kaɗan, gyara suna, karya aiki mai tsayi sosai, ko cire lambar da ba ta da kyau.
Ƙaramin gyaran da aka yi akai-akai ya fi aminci fiye da gyaran da aka yi akai-akai. Kuma koyaushe a tabbatar da isasshen gwaji, ko aƙalla a duba, kafin da bayan canje-canje.
11. Rubuta muhimman shawarwari
Baya ga sharhin lambar, ayyuka masu kyau galibi suna da takaddun bayanai masu taƙaice: yadda ake gudanar da aikace-aikacen, yadda ake gina shi, yadda ake tsara muhalli, da kuma babban bayani game da gine-gine. Ba dole ba ne wannan takaddun ya zama mai faɗi, amma ya kamata ya zama daidai kuma mai sauƙin samu. Fayil mai kyau kamar `README.md` zai iya adana lokaci mai yawa wajen shigar da sabbin membobi.
Idan akwai wata muhimmiyar shawara ta fasaha (misali, zaɓar wani takamaiman bayanai, tsarin gine-gine, ko ƙuntatawa ta haɗin kai), rubuta dalilan. Wannan yana taimaka wa ƙungiyar ta fahimci mahallin kuma ta guji maimaita tattaunawa iri ɗaya.
Penutup
Lambar da za a iya kiyayewa sakamakon kyawawan halaye ne: rubutawa a sarari, rage nauyin da ke wuya, kiyaye daidaito, rage sarkakiya, da kuma kare canje-canje ta hanyar gwaje-gwaje. Babu lambar da ta cika, amma kowane aiki zai iya ci gaba da ingantawa idan ƙungiyar ta himmatu ga inganci. Ta hanyar aiwatar da shawarwarin da ke sama, za ku kasance cikin shiri don bunƙasa—ba kawai a yau ba, har ma a cikin watanni da shekaru masu zuwa.
