Kuwa Muhimu!!

TL;DR: Kazi zilizo na majina yasiyoeleweka huficha dhamira na kuwachanganya wasomaji. Tumia majina ya maelezo, yenye mwelekeo wa vitendo.

Matatizo

• Kusudi la utendakazi lisilo wazi
• Kuongezeka kwa mzigo wa utambuzi
• Muktadha unaopotosha
• Kupungua kwa usomaji
• Ushirikiano mgumu
• Utendaji uliofichwa

Ufumbuzi

1. Tumia vitenzi vyenye mwelekeo wa vitendo
2. Fafanua majina
3. Onyesha madhumuni ya chaguo za kukokotoa
4. Epuka masharti ya jumla
5. Toa muktadha wa maana
6. Eleza wajibu mmoja kwa uwazi
7. Linganisha hatua na matokeo

Refactorings

https://hackernoon.com/improving-the-code-one-line-at-a-time

Muktadha

Kazi zilizotajwa kwa maneno ya jumla huwalazimisha wasomaji kuzama katika utekelezaji ili kuelewa tabia zao.

Hii inapoteza muda na huongeza uwezekano wa makosa.

Kutaja kunakuwa muhimu zaidi wakati wa kufanya kazi na vitendaji vya pekee, ambapo jina la darasa halitoi muktadha wa ziada.

Suala hili linahusiana moja kwa moja na kanuni ya Mwambie, Usiulize .

Badala ya kufichua tabia zisizoeleweka ambazo humlazimu mpigaji kukisia utendakazi, majina shuruti huwasilisha kitendo halisi, kikimwongoza msomaji bila kuhitaji kukagua msimbo.

Unapotaja kazi kwa maelezo, unaondoa ubashiri usio wa lazima na upatanishe na kanuni hii.

Sampuli ya Kanuni

Si sahihi

 public String dateFormatting(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void load() { System.out.println("Loading..."); }

Sawa

 public String formatDate(Date date) { return new SimpleDateFormat("yyyy-MM-dd").format(date); } public void loadUserPreferences() { System.out.println("Loading user preferences..."); }

Ugunduzi

• [x] Mwongozo

Unaweza kugundua harufu hii kwa kukagua majina ya utendakazi yanayotumia maneno yasiyoeleweka kama vile do , run , process , load , n.k.

Linter otomatiki zinaweza kualamisha ruwaza hizi au kuangazia vitendaji vilivyo na majina ya jumla kupita kiasi.

Lebo

• Kutaja

Kiwango

• [x] Mwanzilishi

Kwa Nini Upinzani Ni Muhimu

Majina ya kazi yanapaswa kuunda mawasiliano ya moja kwa moja kati ya jina na utendakazi wao.

Kuvunja Bijection hii hulazimisha wasanidi programu kuchunguza maelezo ya msimbo kwa muktadha, kupunguza kasi ya utatuzi, ukaguzi na viendelezi.

Kizazi cha AI

Zana za AI wakati mwingine hutoa majina ya kazi ya jumla bila kuelewa kikoa chako.

Unapotumia AI, taja kwamba majina ya chaguo za kukokotoa lazima yawe ya maelezo na yenye mwelekeo wa vitendo.

Utambuzi wa AI

Miundo ya AI inaweza kusaidia kugundua majina yenye utata kwa kulinganisha saini za kazi na mbinu bora za kutaja zilizoainishwa awali.

Kuchanganya AI na ukaguzi wa msimbo wa mwongozo hutoa matokeo bora.

Jaribu Them!

Kumbuka: Wasaidizi wa AI hufanya makosa mengi

Hitimisho

Majina ya kazi sio tu lebo; ni mikataba na msomaji.

Majina yenye utata yanavunja mkataba huu na kusababisha mkanganyiko.

Majina yenye maelezo, yanayolenga vitendo hurahisisha mawasiliano na kurahisisha msimbo wako kudumisha na kupanua.

Mahusiano

Tazama pia

Kanusho

Code Harufu ni maoni yangu.

Mikopo

Picha na britihlibrary kwenye Unsplash

Jina la utendaji linapaswa kuwa kitenzi au kishazi cha kitenzi, na linahitaji kuwa na maana

Robert C. Martin

Nakala hii ni sehemu ya Msururu wa CodeSmell.