Hvordan skriver jeg en kodeanmeldelse?

2024 Forfatter: Lynn Donovan | [email protected]. Sist endret: 2024-01-18 08:27

10 tips for å veilede deg mot effektiv evaluering av fagfellekode

1. Anmeldelse færre enn 400 linjer med kode om gangen.
2. Ta den tiden du trenger.
3. Ikke anmeldelse i mer enn 60 minutter av gangen.
4. Sett mål og fange opp beregninger.
5. Forfattere bør kommentere kilden kode før anmeldelse .
6. Bruk sjekklister.
7. Etabler en prosess for å fikse funnet feil.

På samme måte, når bør du gjøre kodegjennomgang?

Når til gjennomgå Kode anmeldelser skal skje etter at automatiserte kontroller (tester, stil, andre CI) er fullført, men før kode fusjonerer til depotets hovedlinjegren. Vi opptrer vanligvis ikke formelt kode anmeldelse av samlede endringer siden siste utgivelse.

I tillegg, hvordan gjør Google kodevurderinger? For å demonstrere sin evne til gjennomgangskode for lesbarhet, utviklere på Google gå gjennom en anmeldelse av deres kode anmeldelse praksis». Derfor sender utbygger kode endringer i et team av lesbarhetseksperter. De vil inspisere kode . Men denne inspeksjonen er ikke som en normal kode anmeldelse.

Spørsmålet er også, hvordan koder du som en menneskelig anmeldelse?

Teknikker

1. La datamaskiner gjøre de kjedelige delene.
2. Avgjør stilargumenter med en stilguide.
3. Begynn gjennomgangen umiddelbart.
4. Start høyt nivå og jobb deg nedover.
5. Vær raus med kodeeksempler.
6. Aldri si "du"
7. Sett inn tilbakemelding som forespørsler, ikke kommandoer.
8. Knyt notater til prinsipper, ikke meninger.

Hva gjør en god kodeanmeldelse?

Gode kodeanmeldelser still åpne spørsmål i stedet for å komme med sterke eller meningsfulle utsagn. De tilbyr alternativer og mulige løsninger som kan fungere bedre for situasjonen uten å insistere på at disse løsningene er beste eller eneste måten å fortsette på.