Hej alla i CodeGym-communityt! Idag ska vi prata om kodkvalitet. Ja, kära vänner. Ingen är perfekt. Alla inser någon gång att koden kan vara bättre... Men vad ska man göra i den här situationen? Börja åtminstone undersöka det här problemet. Men du är redan här, vilket betyder att ämnet måste intressera dig, så låt oss gå. Idag kommer vi att beskriva hur du kan göra din kod bättre och renare. Så du kommer inte att skämmas för din nuvarande kod i framtiden! :) Alla dessa metoder kommer att hjälpa en programmerare att bli en bra programmerare.
1. Om du vill förbättra din kod, läs någon annans
Om du vill förbättra dina programmeringsfärdigheter dramatiskt måste du... läsa kod skriven av andra programmerare. Tro mig eller inte. Men om du tar risken så lovar jag: du kommer att belönas för den tid som spenderas. Läs till exempel inte på medium.com om hur HashMap, ArrayList, LinkedList, etc. fungerar. Läs istället deras källkod och ta reda på det själv. Här är en lista över klasser att läsa:
De vanligaste frågorna i intervjuer handlar om HashMap. Du kan slå två flugor i en smäll: du kommer att förstå koden och få den kunskap du behöver.
Samma sak är sant om ArrayList. Det är inget komplicerat, men källkoden är verkligen värd att läsa och förstå.
String är ett utmärkt exempel. Förstå varför det är oföränderligt.
AtomicInteger är en cool klass: den definierar atomoperationer på heltalsobjekt.
Efter det, ja, vi kunde lista varje klass, en efter en :)
Mer seriöst bör du läsa koden från Pivotal. Folket där har skrivit det mest efterfrågade ekosystemet i Java-världen. Deras kod är definitivt värd att läsa. Jag rekommenderar att du börjar med Spring Core . Att läsa obekant källkod är svårt men givande arbete. :)
2. Följ kodkonventioner
Kodkonventioner är en uppsättning riktlinjer skapade av utvecklingsteam. De inkluderar riktlinjer för kodningsstil och tekniker för varje aspekt av koden. Dessa konventioner kan vara skrivna för hela företaget eller för ett specifikt projekt. Kodkonventioner är i allmänhet specifika för varje programmeringsspråk och täcker filorganisation, indrag, kommentarer, deklarationer, operatorer, mellanslag, namnkonventioner, programmeringstekniker och -principer, programmeringsregler, bästa praxis för arkitektur och så vidare. Den största fördelen med vissa standarder är det faktum att koden ser likadan ut och är skriven i samma stil. Detta gör den mer läsbar och hjälper programmerare att förstå kod skriven av en annan programmerare. Om kodningsstandarder följs och tillämpas konsekvent under hela utvecklingsprocessen, det kommer att bli lättare i framtiden att underhålla och utöka din kod, refaktorisera den och lösa integrationskonflikter. Kodkonventioner är viktiga för programmerare av ett antal anledningar:
40-80 % av kostnaden för programvara går till dess underhåll,
Knappast någon programvara underhålls av dess författare under hela dess liv,
Kodkonventioner förbättrar källkodens läsbarhet genom att tillåta programmerare att förstå ny kod snabbare.
För att vara ärlig så är jag ett stort fan av kodningsstandarder. För mig är det vettigt att lägga tid på att diskutera och argumentera om dem, eftersom det är en värdefull aktivitet som kommer att spara tid och ansträngning i framtiden. Kodkonventioner bör ses över ofta. Regler kan ändras från "obligatoriskt" till "valfritt" och vice versa. Om några av dem inte fungerar som förväntat bör de revideras eller tas bort från riktlinjerna.
3. Använd kodrecensioner
En kodgranskning är ett av de mest kraftfulla verktygen för kodförbättring. Varför? Eftersom koden kommer att tittas på av de experter som inte skrev den. Och ett fräscht utseende är väldigt användbart. Och en kodgranskning är ofta det som hjälper till att förhindra att man skriver rent ut sagt fruktansvärd kod. Jag vet att kodrecensioner inte alltid är möjliga, eftersom du måste hitta en annan person som är villig att göra en. Men det betyder inte att du ska hoppa över att använda det här verktyget. Snarare tvärtom: kodrecensioner är en anledning att hitta likasinnade som också behöver förbättra kvaliteten på sin kod. Förresten, vem kommer att hindra dig från att hitta dem här på CodeGym? På en plats där alla vill vara programmerare.
4. Skriv enhetstester
Min favoritteknik för att förbättra kod är definitivt att skriva enhetstester. Ju fler av dem du skriver, desto bättre. Inom datorprogrammering är enhetstestning en mjukvaruutvecklingsprocess där den minsta testbara källkoden, kallad en enhet, testas individuellt och oberoende för att se om den fungerar som förväntat. Detta hjälper dig att upptäcka fel i dina algoritmer och/eller logik innan du släpper din kod. Eftersom enhetstestning kräver att din kod är strukturerad på rätt sätt, måste koden delas upp i mindre, mer fokuserade funktioner. Var och en är ansvarig för en enda operation på en datamängd, snarare än stora funktioner som utför flera olika operationer ( enkelt ansvarsprincipensäger hej...). Den andra fördelen med att skriva väl testad kod är att du kan undvika att bryta kod när du gör små ändringar i befintlig funktionalitet. När enhetstesten misslyckas kommer de att berätta att något var fel skrivet. Vid första anblicken ser utvecklingstiden som går åt för att skriva enhetstester ut som en extra kostnad. Enhetstest kommer dock att spara tid på felsökning i framtiden. Detta bör vara en steg-för-steg-process. Så låt oss gå vidare med ett leende — vi kommer att skriva tester för varje metod och klass :D
5. Använd verktyg för att förbättra kodkvaliteten
Det finns ingen utvecklare som aldrig har gjort ett misstag. Vanligtvis fångar kompilatorn syntax- och aritmetiska problem och visar stackspåret. Men vissa problem kan fortfarande dyka upp som kompilatorn inte fångar upp. Till exempel felaktigt implementerade krav, felaktiga algoritmer, felaktigt strukturerad kod eller något annat potentiellt problem som communityn känner till av erfarenhet. Det enda sättet att fånga fel som detta är att be en mer senior utvecklare att granska din kod, eller hur? Men detta tillvägagångssätt är inte ett universalmedel och kommer inte att förändra mycket. För varje ny utvecklare i teamet bör du ha ett extra par ögon som tittar på hans/hennes kod. Lyckligtvis finns det många verktyg där ute som kan hjälpa dig att kontrollera kvaliteten på din kod. Jag har använt Checkstyle, PMD, FindBugs och SonarQube i mitt arbete med olika projekt. Och det finns andra också. De används vanligtvis för att analysera kodkvalitet och generera några användbara rapporter. Mycket ofta publiceras dessa rapporter av kontinuerliga integrationsservrar som Jenkins.
6. Skriv enkel och okomplicerad kod
Skriv alltid enkel, begriplig och logisk kod. Människor tenderar att skriva komplicerad kod för att bevisa att de kan göra det. Enkel och logisk kod fungerar alltid bra, leder till färre problem och är mer utbyggbar. Bra kod är den bästa dokumentationen. Om du funderar på att lägga till en kommentar, fråga dig själv: "Hur kan jag förbättra koden så att den här kommentaren inte är nödvändig?" – Steve McConnell.
7. Läs dokumentationen
En av bra programmerares viktigaste vanor är att läsa mycket dokumentation. Oavsett om dess specifikationer, JSR, API-dokument, tutorials eller något annat, läsning av dokumentation hjälper dig att bygga en solid grund för din bästa programmering. Sist men inte minst, jämför inte dig själv med andra. Att jämföra sig med andra leder bara till negativa känslor och ohälsosam konkurrens. Varje person har sina egna styrkor och svagheter. Det betyder att det är viktigt att känna till dem och arbeta med dem. Gör en inventering av dig själv - lista dina styrkor och arbeta med dem. Programmering är ett sant nöje: njut av det.
"En mans konstant är en annan mans variabel."
8. Följ intressanta bloggare
Tusentals entusiaster runt om i världen arbetar med och skriver om samma teknologier. Bloggar skrivs ofta av programmerarna själva, och de flesta delar personliga åsikter och erfarenheter. Genom bloggar kan du se olika perspektiv på samma teknik. Du kan se både bra och dålig teknik på bloggar. Läs åtminstone artiklar om Coding Dojo Blog och CodeGym :) Följ bra bloggar och kommentera inlägg, dela din åsikt.
9. Läs böcker om yrket
Ingenting kan ersätta en bra bok. En bra bok lär ut grundläggande begrepp i en mycket enklare form och gäller saker i den verkliga världen. Deras författare är själva stora programmerare. Genom att läsa böcker kan du lära dig av någon annans erfarenhet. Jag föreslår att du läser Joshua Blochs "Effektiv Java". Den här boken presenterar sjuttioåtta oumbärliga tumregler för programmerare: de bästa fungerande lösningarna för de programmeringsproblem du möter varje dag. Den innehåller de mest praktiska, auktoritativa riktlinjerna för att skriva effektiva, väldesignade program. Om du precis har börjat med Java och inte har någon erfarenhet av programmering kan du läsa "Sams Teach Yourself Java 2 in 24 Hours". Och för att skriva ren kod finns det en utmärkt bok, "Clean Code", av Robert Martin. Efter att ha läst den,
10. Kod! Koda! Koda!
Du kan inte bli en bra programmerare bara genom att memorera en bok. Det är lätt att prata om teoretiska begrepp. Men du kan bara lära dig begränsningarna för ett språk eller utarbeta bästa praxis när du skriver kod. Därför måste du skriva mycket kod för att bli en bra programmerare. Om du är nybörjare, börja med att skriva program för enkla uppgifter som Fibonacci-serien, palindromer, Pascals triangel etc. Gå sedan vidare till större uppgifter som ett binärt sökträd etc. Om du letar efter en onlineplattform för att träna Java program, ta en titt på Coding Ground . Arbeta dig igenom programmeringskurser så garanterar jag att dina kunskaper blir mycket bättre. Ett annat alternativ är att ta Harvard CS50-kursen, som är gratis.
Låt oss sammanfatta
Den som inte gör några misstag är den som inte gör något. Det är därför vi samlar vårt tålamod och, som en hårt arbetande gräshoppa, finslipar vi våra kodningsförmåga. För att göra detta, glöm inte:
Idag ska vi prata om kodkvalitet. Ja, kära vänner. Ingen är perfekt. Alla inser någon gång att koden kan vara bättre... Men vad ska man göra i den här situationen? Börja åtminstone undersöka det här problemet. Men du är redan här, vilket betyder att ämnet måste intressera dig, så låt oss gå. Idag kommer vi att beskriva hur du kan göra din kod bättre och renare. Så du kommer inte att skämmas för din nuvarande kod i framtiden! :) Alla dessa metoder kommer att hjälpa en programmerare att bli en bra programmerare.
Kodkonventioner är en uppsättning riktlinjer skapade av utvecklingsteam. De inkluderar riktlinjer för kodningsstil och tekniker för varje aspekt av koden. Dessa konventioner kan vara skrivna för hela företaget eller för ett specifikt projekt. Kodkonventioner är i allmänhet specifika för varje programmeringsspråk och täcker filorganisation, indrag, kommentarer, deklarationer, operatorer, mellanslag, namnkonventioner, programmeringstekniker och -principer, programmeringsregler, bästa praxis för arkitektur och så vidare. Den största fördelen med vissa standarder är det faktum att koden ser likadan ut och är skriven i samma stil. Detta gör den mer läsbar och hjälper programmerare att förstå kod skriven av en annan programmerare. Om kodningsstandarder följs och tillämpas konsekvent under hela utvecklingsprocessen, det kommer att bli lättare i framtiden att underhålla och utöka din kod, refaktorisera den och lösa integrationskonflikter. Kodkonventioner är viktiga för programmerare av ett antal anledningar:
Varför? Eftersom koden kommer att tittas på av de experter som inte skrev den. Och ett fräscht utseende är väldigt användbart. Och en kodgranskning är ofta det som hjälper till att förhindra att man skriver rent ut sagt fruktansvärd kod. Jag vet att kodrecensioner inte alltid är möjliga, eftersom du måste hitta en annan person som är villig att göra en. Men det betyder inte att du ska hoppa över att använda det här verktyget. Snarare tvärtom: kodrecensioner är en anledning att hitta likasinnade som också behöver förbättra kvaliteten på sin kod. Förresten, vem kommer att hindra dig från att hitta dem här på CodeGym? På en plats där alla vill vara programmerare.
Skriv alltid enkel, begriplig och logisk kod. Människor tenderar att skriva komplicerad kod för att bevisa att de kan göra det. Enkel och logisk kod fungerar alltid bra, leder till färre problem och är mer utbyggbar. Bra kod är den bästa dokumentationen. Om du funderar på att lägga till en kommentar, fråga dig själv: "Hur kan jag förbättra koden så att den här kommentaren inte är nödvändig?" – Steve McConnell.
En av bra programmerares viktigaste vanor är att läsa mycket dokumentation. Oavsett om dess specifikationer, JSR, API-dokument, tutorials eller något annat, läsning av dokumentation hjälper dig att bygga en solid grund för din bästa programmering. Sist men inte minst, jämför inte dig själv med andra. Att jämföra sig med andra leder bara till negativa känslor och ohälsosam konkurrens. Varje person har sina egna styrkor och svagheter. Det betyder att det är viktigt att känna till dem och arbeta med dem. Gör en inventering av dig själv - lista dina styrkor och arbeta med dem. Programmering är ett sant nöje: njut av det.
