Hei alle sammen i CodeGym-fellesskapet! I dag skal vi snakke om kodekvalitet. Ja, kjære venner. Ingen er perfekt. Alle skjønner på et tidspunkt at koden kan være bedre... Men hva skal man gjøre i denne situasjonen? Begynn som et minimum å undersøke dette problemet. Men du er allerede her, noe som betyr at emnet må interessere deg, så la oss gå. I dag skal vi beskrive hvordan du kan gjøre koden din bedre og renere. Så du vil ikke skamme deg over din nåværende kode i fremtiden! :) Alle disse metodene vil hjelpe en programmerer til å bli en god programmerer.
1. Hvis du vil forbedre koden din, les noen andres
Hvis du vil forbedre dine programmeringsferdigheter dramatisk, må du... lese kode skrevet av andre programmerere. Tro meg eller ikke. Men hvis du tar risikoen, lover jeg: du vil bli belønnet for tiden du bruker. For eksempel, ikke les på medium.com om hvordan HashMap, ArrayList, LinkedList osv. fungerer. Les i stedet kildekoden deres og finn ut av det selv. Her er en liste over klasser å lese:
De oftest stilte spørsmålene i intervjuer handler om HashMap. Du kan slå to fluer i en smekk: du vil forstå koden og få kunnskapen du trenger.
Det samme gjelder ArrayList. Det er ikke noe komplisert, men kildekoden er virkelig verdt å lese og forstå.
String er et utmerket eksempel. Forstå hvorfor det er uforanderlig.
AtomicInteger er en kul klasse: den definerer atomoperasjoner på Integer-objekter.
Etter det, vel, kunne vi liste opp hver klasse, en etter en :)
Mer seriøst bør du lese koden fra Pivotal. Folkene der har skrevet det mest etterspurte økosystemet i Java-verdenen. Koden deres er definitivt verdt å lese. Jeg anbefaler at du starter med Spring Core . Å lese ukjent kildekode er vanskelig, men givende arbeid. :)
2. Følg kodekonvensjonene
Kodekonvensjoner er et sett med retningslinjer laget av utviklingsteam. De inkluderer retningslinjer for kodestil og teknikker for alle aspekter av koden. Disse konvensjonene kan være skrevet for hele selskapet eller for et spesifikt prosjekt. Kodekonvensjoner er generelt spesifikke for hvert programmeringsspråk og dekker filorganisering, innrykk, kommentarer, erklæringer, operatorer, mellomrom, navnekonvensjoner, programmeringsteknikker og -prinsipper, programmeringsregler, beste praksis for arkitektur og så videre. Hovedfordelen med visse standarder er det faktum at koden ser lik ut og er skrevet i samme stil. Dette gjør det mer lesbart og hjelper programmerere å forstå kode skrevet av en annen programmerer. Hvis kodestandarder følges og brukes konsekvent gjennom hele utviklingsprosessen, det vil være lettere i fremtiden å vedlikeholde og utvide koden din, refaktorisere den og løse integrasjonskonflikter. Kodekonvensjoner er viktige for programmerere av en rekke årsaker:
40–80 % av kostnadene for programvare går til vedlikehold,
Knapt noen programvare vedlikeholdes av forfatteren gjennom hele livet,
Kodekonvensjoner forbedrer lesbarheten til kildekoden ved å la programmerere forstå ny kode raskere.
For å være ærlig er jeg en stor fan av kodestandarder. For meg er det fornuftig å bruke tid på å diskutere og krangle om dem, siden det er en verdifull aktivitet som vil spare deg for tid og krefter i fremtiden. Kodekonvensjoner bør gjennomgås ofte. Regler kan endres fra "obligatorisk" til "valgfritt" og omvendt. Hvis noen av dem ikke fungerer som forventet, bør de revideres eller fjernes fra retningslinjene.
3. Bruk kodeanmeldelser
En kodegjennomgang er et av de kraftigste verktøyene for kodeforbedring. Hvorfor? Fordi koden vil bli sett på av de ekspertene som ikke har skrevet den. Og et friskt utseende er veldig nyttig. Og en kodegjennomgang er ofte det som hjelper til med å forhindre å skrive direkte forferdelig kode. Jeg vet at kodevurderinger ikke alltid er mulig, fordi du må finne en annen person som er villig til å gjøre en. Men det betyr ikke at du bør hoppe over å bruke dette verktøyet. Snarere motsatt: kodeanmeldelser er en grunn til å finne likesinnede som også trenger å forbedre kvaliteten på koden sin. Hvem skal forresten hindre deg i å finne dem her på CodeGym? På et sted der alle ønsker å være programmerere.
4. Skriv enhetstester
Min favorittteknikk for å forbedre kode er definitivt å skrive enhetstester. Jo flere av dem du skriver, jo bedre. I dataprogrammering er enhetstesting en programvareutviklingsprosess der den minste testbare kildekoden, kalt en enhet, testes individuelt og uavhengig for å se om den fungerer som forventet. Dette vil hjelpe deg med å oppdage feil i algoritmene og/eller logikken før du slipper koden. Fordi enhetstesting krever at koden din er strukturert riktig, må koden deles opp i mindre, mer fokuserte funksjoner. Hver er ansvarlig for en enkelt operasjon på et datasett, i stedet for store funksjoner som utfører flere forskjellige operasjoner ( enkeltansvarsprinsippetsier hei...). Den andre fordelen med å skrive godt testet kode er at du kan unngå å knekke kode når du gjør små endringer i eksisterende funksjonalitet. Når enhetstestene mislykkes, vil de fortelle deg at noe ble skrevet feil. Ved første øyekast ser utviklingstiden brukt på å skrive enhetstester ut som en ekstra kostnad. Enhetstester vil imidlertid spare tid på feilsøking i fremtiden. Dette bør være en trinnvis prosess. Så la oss gå videre med et smil — vi skriver tester for hver metode og klasse :D
5. Bruk verktøy for å forbedre kodekvaliteten
Det er ingen utvikler som aldri har gjort en feil. Vanligvis fanger kompilatoren syntaks- og aritmetiske problemer og viser stabelsporet. Men noen problemer kan fortsatt dukke opp som kompilatoren ikke fanger opp. For eksempel feil implementerte krav, feil algoritmer, feil strukturert kode eller et annet potensielt problem som fellesskapet kjenner av erfaring. Den eneste måten å fange opp feil som dette er å be en mer senior utvikler om å se gjennom koden din, ikke sant? Men denne tilnærmingen er ikke et universalmiddel og vil ikke endre mye. For hver nye utvikler i teamet bør du ha et ekstra par øyne som ser på koden hans/hennes. Heldigvis er det mange verktøy der ute som kan hjelpe deg med å kontrollere kvaliteten på koden din. Jeg har brukt Checkstyle, PMD, FindBugs og SonarQube i arbeidet mitt med forskjellige prosjekter. Og det er andre også. De brukes vanligvis alle til å analysere kodekvalitet og generere noen nyttige rapporter. Svært ofte publiseres disse rapportene av kontinuerlige integrasjonsservere som Jenkins.
6. Skriv enkel og grei kode
Skriv alltid enkel, forståelig og logisk kode. Folk har en tendens til å skrive komplisert kode for å bevise at de kan gjøre det. Enkel og logisk kode fungerer alltid bra, fører til færre problemer og er mer utvidbar. God kode er den beste dokumentasjonen. Hvis du tenker å legge til en kommentar, spør deg selv: "Hvordan kan jeg forbedre koden slik at denne kommentaren ikke er nødvendig?" – Steve McConnell.
7. Les dokumentasjonen
En av de viktigste vanene til gode programmerere er å lese mye dokumentasjon. Enten spesifikasjonene, JSR-er, API-dokumenter, opplæringsprogrammer eller noe annet, hjelper lesing av dokumentasjon deg med å bygge et solid grunnlag for din beste programmering. Sist men ikke minst, ikke sammenlign deg selv med andre. Å sammenligne deg selv med andre vil bare føre til negative følelser og usunn konkurranse. Hver person har sine egne styrker og svakheter. Dette betyr at det er viktig å kjenne dem og jobbe med dem. Ta en oversikt over deg selv – oppgi dine styrker og arbeid med dem. Programmering er en sann nytelse: nyt det.
"En manns konstant er en annen manns variabel."
8. Følg interessante bloggere
Tusenvis av entusiaster over hele verden jobber med og skriver om de samme teknologiene. Blogger er ofte skrevet av programmererne selv, og de fleste deler personlige meninger og erfaringer. Gjennom blogger kan du se ulike perspektiver på samme teknologi. Du kan se både god og dårlig teknologi på blogger. Les som et minimum artikler på Coding Dojo Blog og CodeGym :) Følg gode blogger og kommenter innlegg, del din mening.
9. Les bøker om yrket
Ingenting kan erstatte en god bok. En god bok lærer grunnleggende konsepter i en mye enklere form og gjelder ting i den virkelige verden. Forfatterne deres er selv gode programmerere. Ved å lese bøker kan du lære av andres erfaring. Jeg foreslår at du leser Joshua Blochs "Effektiv Java". Denne boken presenterer syttiåtte uunnværlige tommelfingerregler for programmerere: de beste fungerende løsningene for programmeringsproblemene du møter hver dag. Den inneholder de mest praktiske, autoritative retningslinjene for å skrive effektive, godt utformede programmer. Hvis du akkurat har begynt med Java og ikke har noen programmeringserfaring, kan du lese «Sams Teach Yourself Java 2 in 24 Hours». Og for å skrive ren kode, er det en utmerket bok, "Clean Code", av Robert Martin. Etter å ha lest den,
10. Kode! Kode! Kode!
Du kan ikke bli en god programmerer bare ved å huske en bok. Det er lett å snakke om teoretiske begreper. Men du kan bare lære begrensningene til et språk eller utarbeide beste praksis når du skriver kode. Derfor, for å bli en god programmerer, må du skrive mye kode. Hvis du er nybegynner, start med å skrive programmer for enkle oppgaver som Fibonacci-serien, palindromer, Pascals trekant osv. Gå deretter videre til større oppgaver som et binært søketre osv. Hvis du leter etter en nettplattform for å praktisere Java programmer, ta en titt på Coding Ground . Arbeid deg gjennom programmeringskurs og jeg garanterer at ferdighetene dine blir mye bedre. Et annet alternativ er å ta Harvard CS50-kurset, som er gratis.
La oss oppsummere
Den som ikke gjør noen feil er den som ikke gjør noe. Det er derfor vi samler vår tålmodighet og, som en hardtarbeidende gresshoppe, finpusser vi kodingsferdighetene våre. For å gjøre dette, ikke glem:
I dag skal vi snakke om kodekvalitet. Ja, kjære venner. Ingen er perfekt. Alle skjønner på et tidspunkt at koden kan være bedre... Men hva skal man gjøre i denne situasjonen? Begynn som et minimum å undersøke dette problemet. Men du er allerede her, noe som betyr at emnet må interessere deg, så la oss gå. I dag skal vi beskrive hvordan du kan gjøre koden din bedre og renere. Så du vil ikke skamme deg over din nåværende kode i fremtiden! :) Alle disse metodene vil hjelpe en programmerer til å bli en god programmerer.
Kodekonvensjoner er et sett med retningslinjer laget av utviklingsteam. De inkluderer retningslinjer for kodestil og teknikker for alle aspekter av koden. Disse konvensjonene kan være skrevet for hele selskapet eller for et spesifikt prosjekt. Kodekonvensjoner er generelt spesifikke for hvert programmeringsspråk og dekker filorganisering, innrykk, kommentarer, erklæringer, operatorer, mellomrom, navnekonvensjoner, programmeringsteknikker og -prinsipper, programmeringsregler, beste praksis for arkitektur og så videre. Hovedfordelen med visse standarder er det faktum at koden ser lik ut og er skrevet i samme stil. Dette gjør det mer lesbart og hjelper programmerere å forstå kode skrevet av en annen programmerer. Hvis kodestandarder følges og brukes konsekvent gjennom hele utviklingsprosessen, det vil være lettere i fremtiden å vedlikeholde og utvide koden din, refaktorisere den og løse integrasjonskonflikter. Kodekonvensjoner er viktige for programmerere av en rekke årsaker:
Hvorfor? Fordi koden vil bli sett på av de ekspertene som ikke har skrevet den. Og et friskt utseende er veldig nyttig. Og en kodegjennomgang er ofte det som hjelper til med å forhindre å skrive direkte forferdelig kode. Jeg vet at kodevurderinger ikke alltid er mulig, fordi du må finne en annen person som er villig til å gjøre en. Men det betyr ikke at du bør hoppe over å bruke dette verktøyet. Snarere motsatt: kodeanmeldelser er en grunn til å finne likesinnede som også trenger å forbedre kvaliteten på koden sin. Hvem skal forresten hindre deg i å finne dem her på CodeGym? På et sted der alle ønsker å være programmerere.
Skriv alltid enkel, forståelig og logisk kode. Folk har en tendens til å skrive komplisert kode for å bevise at de kan gjøre det. Enkel og logisk kode fungerer alltid bra, fører til færre problemer og er mer utvidbar. God kode er den beste dokumentasjonen. Hvis du tenker å legge til en kommentar, spør deg selv: "Hvordan kan jeg forbedre koden slik at denne kommentaren ikke er nødvendig?" – Steve McConnell.
En av de viktigste vanene til gode programmerere er å lese mye dokumentasjon. Enten spesifikasjonene, JSR-er, API-dokumenter, opplæringsprogrammer eller noe annet, hjelper lesing av dokumentasjon deg med å bygge et solid grunnlag for din beste programmering. Sist men ikke minst, ikke sammenlign deg selv med andre. Å sammenligne deg selv med andre vil bare føre til negative følelser og usunn konkurranse. Hver person har sine egne styrker og svakheter. Dette betyr at det er viktig å kjenne dem og jobbe med dem. Ta en oversikt over deg selv – oppgi dine styrker og arbeid med dem. Programmering er en sann nytelse: nyt det.
GO TO FULL VERSION