Üdv mindenkinek a CodeGym közösségben! Ma a kódminőségről fogunk beszélni. Igen, kedves barátaim. Senki sem tökéletes. Mindenki rájön egy ponton, hogy a kód lehetne jobb... De mit kell tenni ebben a helyzetben? Minimum kezdje el ennek a kérdésnek a kutatását. De már itt vagy, ami azt jelenti, hogy a téma biztosan érdekelni fog téged, úgyhogy menjünk. Ma leírjuk, hogyan teheti jobbá és tisztábbá kódját. Így a jövőben sem fog szégyellni jelenlegi kódját! :) Mindezek a módszerek segítenek egy programozónak jó programozóvá válni.
1. Ha javítani szeretné a kódját, olvassa el valaki másét
Ha drámai mértékben szeretné fejleszteni programozási készségeit, el kell olvasnia más programozók által írt kódot. Hisz nekem vagy sem. De ha vállalja a kockázatot, megígérem: jutalmat kap az eltöltött időért. Például ne olvassa el a medium.com-on a HashMap, ArrayList, LinkedList stb. működését. Ehelyett olvassa el a forráskódjukat, és találja ki maga. Íme az olvasandó osztályok listája:
Az interjúk során leggyakrabban feltett kérdések a HashMap-re vonatkoznak. Két legyet megölhetsz egy csapásra: megérted a kódot, és megszerezheted a szükséges tudást.
Ugyanez igaz az ArrayListre is. Nincs semmi bonyolult, de a forráskódot valóban érdemes elolvasni és megérteni.
A string kiváló példa. Értsd meg, miért változhatatlan.
Az AtomicInteger egy klassz osztály: atomi műveleteket határoz meg Integer objektumokon.
Ezek után, nos, sorolhatnánk minden órát, egymás után :)
Komolyabban érdemes elolvasni a Pivotal kódját. Az ottaniak megírták a Java világ legkeresettebb ökoszisztémáját. A kódjukat mindenképpen érdemes elolvasni. Azt javaslom, hogy kezdje a Spring Core- el . Az ismeretlen forráskód olvasása nehéz, de kifizetődő munka. :)
2. Kövesse a kódegyezményeket
A kódolási konvenciók a fejlesztőcsapatok által létrehozott irányelvek halmaza. Ezek tartalmazzák a kódolási stílusra és technikákra vonatkozó irányelveket a kód minden aspektusához. Ezek az egyezmények az egész vállalatra vagy egy adott projektre vonatkozhatnak. A kódolási konvenciók általában minden programozási nyelvre jellemzőek, és lefedik a fájlszervezést, a behúzást, a megjegyzéseket, a deklarációkat, az operátorokat, a szóközöket, az elnevezési konvenciókat, a programozási technikákat és elveket, a programozási szabályokat, az architektúrára vonatkozó legjobb gyakorlatokat stb. Bizonyos szabványok fő előnye, hogy a kód ugyanúgy néz ki, és ugyanabban a stílusban van megírva. Ez olvashatóbbá teszi, és segít a programozóknak megérteni egy másik programozó által írt kódot. Ha a kódolási szabványokat követik és következetesen alkalmazzák a fejlesztési folyamat során, a jövőben könnyebb lesz karbantartani és kibővíteni a kódot, újraépíteni és megoldani az integrációs konfliktusokat. A kódolási konvenciók számos okból fontosak a programozók számára:
A szoftverek költségének 40-80%-a a karbantartására megy,
Alig van szoftvert karbantartani a szerzője élete során,
A kódolási konvenciók javítják a forráskód olvashatóságát azáltal, hogy lehetővé teszik a programozók számára az új kód gyorsabb megértését.
Őszintén szólva nagy rajongója vagyok a kódolási szabványoknak. Számomra logikus, hogy időt szánok a megvitatásra és vitára, mivel ez egy értékes tevékenység, amellyel időt és erőfeszítést takaríthat meg a jövőben. A kódkonvenciókat gyakran felül kell vizsgálni. A szabályok módosíthatók „kötelező”-ről „opcionális”-ra és fordítva. Ha ezek közül néhány nem működik a várt módon, felül kell vizsgálni vagy törölni kell az irányelvekből.
3. Használjon kódértékeléseket
A kód áttekintése a kódjavítás egyik leghatékonyabb eszköze. Miért? Mert a kódot azok a szakértők fogják megnézni, akik nem írták. A friss megjelenés pedig nagyon hasznos. A kód áttekintése pedig gyakran segít megakadályozni, hogy kifejezetten szörnyű kódokat írjanak. Tudom, hogy a kód áttekintése nem mindig lehetséges, mert keresni kell egy másik személyt, aki hajlandó megtenni. Ez azonban nem jelenti azt, hogy ki kell hagynia ennek az eszköznek a használatát. Éppen ellenkezőleg: a kód áttekintése ok arra, hogy hasonló gondolkodású embereket találjunk, akiknek szintén javítaniuk kell kódjuk minőségén. Egyébként ki akadályoz meg abban, hogy megtaláld őket itt a CodeGym-en? Egy olyan helyen, ahol mindenki programozó akar lenni.
4. Írjon egységteszteket
A kedvenc kódjavítási technikám egyértelműen az egységtesztek írása. Minél többet írsz belőlük, annál jobb. A számítógép-programozásban az egységtesztelés egy olyan szoftverfejlesztési folyamat, amelyben a forráskód legkisebb tesztelhető darabját, az úgynevezett egységet külön-külön és függetlenül tesztelik, hogy kiderüljön, az elvárásoknak megfelelően működik-e. Ez segít felfedezni a hibákat az algoritmusaiban és/vagy a logikájában a kód kiadása előtt. Mivel az egységtesztelés megköveteli a kód megfelelő felépítését, a kódot kisebb, célzottabb funkciókra kell felosztani. Mindegyik egy adathalmaz egyetlen műveletéért felelős, nem pedig olyan nagy funkciókért, amelyek több különböző műveletet hajtanak végre (az egységes felelősség elveköszön...). A jól tesztelt kód írásának másik előnye, hogy elkerülheti a kód feltörését, amikor kisebb változtatásokat hajt végre a meglévő funkciókon. Ha az egységtesztek kudarcot vallanak, azt jelzik, hogy valamit rosszul írtak. Első pillantásra az egységtesztek megírására fordított fejlesztési idő többletköltségnek tűnik. Az egységtesztek azonban időt takarítanak meg a hibakeresésre a jövőben. Ennek lépésről lépésre kell történnie. Szóval haladjunk inkább mosolyogva — minden módszerhez és osztályhoz írunk teszteket :D
5. Használjon eszközöket a kód minőségének javítására
Nincs olyan fejlesztő, aki soha nem hibázott volna. A fordító általában elkapja a szintaktikai és aritmetikai problémákat, és megjeleníti a verem nyomkövetését. De előfordulhatnak olyan problémák, amelyeket a fordító nem észlel. Például nem megfelelően végrehajtott követelmények, helytelen algoritmusok, helytelenül strukturált kód vagy más lehetséges probléma, amelyet a közösség tapasztalatból ismer. Az ilyen hibák egyetlen módja az, hogy megkérünk egy magasabb rangú fejlesztőt, hogy vizsgálja felül a kódot, igaz? De ez a megközelítés nem csodaszer, és nem sokat változtat rajta. A csapat minden új fejlesztőjének egy extra szempárral kell rendelkeznie a kódjára nézve. Szerencsére sok olyan eszköz létezik, amelyek segíthetnek a kód minőségének szabályozásában. A Checkstyle-t, a PMD-t, a FindBugst és a SonarQube-ot használtam különféle projekteken végzett munkám során. És vannak mások is. Általában mindegyiket a kódminőség elemzésére és hasznos jelentések készítésére használják. Ezeket a jelentéseket gyakran olyan folyamatos integrációs szerverek teszik közzé, mint a Jenkins.
6. Írjon egyszerű és egyértelmű kódot
Mindig egyszerű, érthető és logikus kódot írjon. Az emberek hajlamosak bonyolult kódokat írni, hogy bebizonyítsák, képesek rá. Az egyszerű és logikus kód mindig jól működik, kevesebb problémát okoz, és jobban bővíthető. A jó kód a legjobb dokumentáció. Ha megjegyzést szeretne hozzáadni, tegye fel magának a kérdést: "Hogyan javíthatom a kódot úgy, hogy ez a megjegyzés ne legyen szükséges?" – Steve McConnell.
7. Olvassa el a dokumentációt
A jó programozók egyik legfontosabb szokása a sok dokumentáció elolvasása. Legyen szó specifikációkról, JSR-ekről, API-dokumentumokról, oktatóanyagokról vagy valami másról, a dokumentáció olvasása segít szilárd alapot építeni a legjobb programozáshoz. Végül, de nem utolsósorban, ne hasonlítsd magad másokhoz. Ha összehasonlítod magad másokkal, az csak negatív érzésekhez és egészségtelen versenyhez vezet. Minden embernek megvannak a maga erősségei és gyengeségei. Ez azt jelenti, hogy fontos ismerni őket és dolgozni velük. Készítsen leltárt önmagáról – sorolja fel erősségeit, és dolgozzon rajtuk. A programozás igazi élvezet: élvezd.
"Az egyik ember állandója egy másik ember változója."
8. Kövess érdekes bloggereket
Világszerte rajongók ezrei dolgoznak ugyanazokkal a technológiákkal, és írnak róluk. A blogokat gyakran maguk a programozók írják, és legtöbbjük személyes véleményeket és tapasztalatokat oszt meg. A blogokon keresztül különböző perspektívákat láthat ugyanarról a technológiáról. A blogokon jó és rossz technológiákat is láthatunk. Minimum olvass cikkeket a Coding Dojo Blogon és a CodeGym-en :) Kövess jó blogokat és kommenteld a bejegyzéseket, oszd meg a véleményed.
9. Olvasson könyveket a szakmáról
Egy jó könyvet semmi sem helyettesíthet. Egy jó könyv sokkal egyszerűbb formában tanítja meg az alapfogalmakat, és a való világ dolgaira vonatkozik. Szerzőik maguk is nagyszerű programozók. Ha könyveket olvas, tanulhat valaki más tapasztalataiból. Azt javaslom, olvassa el Joshua Bloch "Effective Java" című művét. Ez a könyv hetvennyolc nélkülözhetetlen ökölszabályt mutat be a programozók számára: a legjobban működő megoldásokat a mindennapi programozási problémákra. Ez tartalmazza a legpraktikusabb, leghitelesebb irányelveket a hatékony, jól megtervezett programok megírásához. Ha még csak most kezdi a Java használatát, és nincs programozási tapasztalata, olvassa el a „Sams Teach Yourself Java 2 in 24 Hours” című részt. A tiszta kód írására pedig van egy kiváló könyv, a "Clean Code" Robert Martintól. Miután elolvasta,
10. Kód! Kód! Kód!
Nem válhatsz jó programozóvá pusztán attól, hogy memorizálsz egy könyvet. Könnyű elméleti fogalmakról beszélni. De csak akkor tanulhatja meg a nyelv korlátait, vagy dolgozhat ki bevált gyakorlatokat, amikor kódot ír. Ezért ahhoz, hogy jó programozó legyen, sok kódot kell írnia. Ha Ön kezdő, kezdje azzal, hogy írjon programokat olyan egyszerű feladatokhoz, mint a Fibonacci sorozat, palindromok, Pascal-háromszög stb. Ezután lépjen tovább a nagyobb feladatokra, mint például a bináris keresőfa stb. Ha online platformot keres a Java gyakorlásához programokat, vessen egy pillantást a Coding Ground oldalra . Dolgozzon végig programozási tanfolyamokon, és garantálom, hogy képességei sokkal jobbak lesznek. Egy másik lehetőség a Harvard CS50 tanfolyam elvégzése, amely ingyenes.
Foglaljuk össze
Aki nem hibázik, az nem csinál semmit. Ezért gyűjtjük a türelmünket, és mint egy szorgalmas szöcske, csiszoljuk kódolási készségeinket. Ehhez ne felejtse el:
Olvassa el mások kódját
Adjon meg és kérjen kódellenőrzést
Írjon egységteszteket
Használjon eszközöket a kód javításához
Írj egyszerű és érthető kódot
Olvassa el az általa írt dokumentációt, aki teheti
Ma a kódminőségről fogunk beszélni. Igen, kedves barátaim. Senki sem tökéletes. Mindenki rájön egy ponton, hogy a kód lehetne jobb... De mit kell tenni ebben a helyzetben? Minimum kezdje el ennek a kérdésnek a kutatását. De már itt vagy, ami azt jelenti, hogy a téma biztosan érdekelni fog téged, úgyhogy menjünk. Ma leírjuk, hogyan teheti jobbá és tisztábbá kódját. Így a jövőben sem fog szégyellni jelenlegi kódját! :) Mindezek a módszerek segítenek egy programozónak jó programozóvá válni.
A kódolási konvenciók a fejlesztőcsapatok által létrehozott irányelvek halmaza. Ezek tartalmazzák a kódolási stílusra és technikákra vonatkozó irányelveket a kód minden aspektusához. Ezek az egyezmények az egész vállalatra vagy egy adott projektre vonatkozhatnak. A kódolási konvenciók általában minden programozási nyelvre jellemzőek, és lefedik a fájlszervezést, a behúzást, a megjegyzéseket, a deklarációkat, az operátorokat, a szóközöket, az elnevezési konvenciókat, a programozási technikákat és elveket, a programozási szabályokat, az architektúrára vonatkozó legjobb gyakorlatokat stb. Bizonyos szabványok fő előnye, hogy a kód ugyanúgy néz ki, és ugyanabban a stílusban van megírva. Ez olvashatóbbá teszi, és segít a programozóknak megérteni egy másik programozó által írt kódot. Ha a kódolási szabványokat követik és következetesen alkalmazzák a fejlesztési folyamat során, a jövőben könnyebb lesz karbantartani és kibővíteni a kódot, újraépíteni és megoldani az integrációs konfliktusokat. A kódolási konvenciók számos okból fontosak a programozók számára:
Miért? Mert a kódot azok a szakértők fogják megnézni, akik nem írták. A friss megjelenés pedig nagyon hasznos. A kód áttekintése pedig gyakran segít megakadályozni, hogy kifejezetten szörnyű kódokat írjanak. Tudom, hogy a kód áttekintése nem mindig lehetséges, mert keresni kell egy másik személyt, aki hajlandó megtenni. Ez azonban nem jelenti azt, hogy ki kell hagynia ennek az eszköznek a használatát. Éppen ellenkezőleg: a kód áttekintése ok arra, hogy hasonló gondolkodású embereket találjunk, akiknek szintén javítaniuk kell kódjuk minőségén. Egyébként ki akadályoz meg abban, hogy megtaláld őket itt a CodeGym-en? Egy olyan helyen, ahol mindenki programozó akar lenni.
Mindig egyszerű, érthető és logikus kódot írjon. Az emberek hajlamosak bonyolult kódokat írni, hogy bebizonyítsák, képesek rá. Az egyszerű és logikus kód mindig jól működik, kevesebb problémát okoz, és jobban bővíthető. A jó kód a legjobb dokumentáció. Ha megjegyzést szeretne hozzáadni, tegye fel magának a kérdést: "Hogyan javíthatom a kódot úgy, hogy ez a megjegyzés ne legyen szükséges?" – Steve McConnell.
A jó programozók egyik legfontosabb szokása a sok dokumentáció elolvasása. Legyen szó specifikációkról, JSR-ekről, API-dokumentumokról, oktatóanyagokról vagy valami másról, a dokumentáció olvasása segít szilárd alapot építeni a legjobb programozáshoz. Végül, de nem utolsósorban, ne hasonlítsd magad másokhoz. Ha összehasonlítod magad másokkal, az csak negatív érzésekhez és egészségtelen versenyhez vezet. Minden embernek megvannak a maga erősségei és gyengeségei. Ez azt jelenti, hogy fontos ismerni őket és dolgozni velük. Készítsen leltárt önmagáról – sorolja fel erősségeit, és dolgozzon rajtuk. A programozás igazi élvezet: élvezd.
GO TO FULL VERSION