Kaip pateikti kodo ištrauką paaiškinimui ar peržiūrai?
Susiaurinkite apimtį, kad atsakyme būtų atskirti kodo pastebėjimai nuo vykdymu pagrįstų išvadų.
Apribokite nagrinėjamo kodo apimtį
Pirmiausia pateikite peržiūrimą funkciją ar atitinkamą ištrauką, nurodykite kalbą, iškvietimo būdą ir numatytą elgesį. Jei problema priklauso nuo konfigūracijos, įvesties formato ar kitų funkcijų, pridėkite minimalų būtiną kontekstą. Aiškiai pasakykite, ar norite suprasti valdymo eigą, ribines sąlygas, ar galimas problemas, kad atsakymas nevirstų bendru viso projekto kontroliniu sąrašu.
Nurodykite konkrečius peržiūros tikslus
Galite parašyti: „Paaiškink, kaip ši funkcija apdoroja tuščią įvestį, ir nurodyk ribinius atvejus, kuriuos reikėtų išbandyti.“ Jei norite pakeitimų pasiūlymų, paprašykite paaiškinti jų priežastis ir tikėtiną poveikį. Įklijuodami kodą tiesiogiai arba pateikdami jį prieinamais priedais, visada patikrinkite įtraukas ir failų pavadinimus; dėl patogumo neįtraukite tikrų raktų ar kitų paslapčių.
- Pateikite susijusį kodą, kalbą ir laukiamus rezultatus.
- Aprašykite tikrąjį elgesį arba labiausiai rūpimas rizikas.
- Paprašykite atskirai išvardyti pastebėjimus, pasiūlymus ir tikrinimo būdus.
Patikrinkite, kurie peržiūros veiksmai atlikti
Vien perskaičius kodą padarytos išvados yra statinė analizė ir nereiškia, kad buvo vykdyti testai. Jei atsakyme teigiama, jog programa buvo paleista, patikrinkite atitinkamą įrankių išvestį; jei aplinka neprieinama, paprašykite išvardyti nepatikrintas dalis. Prieš priimant pakeitimus elgesį vis tiek reikia patikrinti tinkamoje aplinkoje, ypač įsitikinti, kad ir įprastos įvesties, ir klaidų apdorojimas atitinka lūkesčius.