Turinys:

Kaip parašyti kodo apžvalgą?
Kaip parašyti kodo apžvalgą?

Video: Kaip parašyti kodo apžvalgą?

Video: Kaip parašyti kodo apžvalgą?
Video: Code Review Best Practices For Software Engineers 2024, Gruodis
Anonim

10 patarimų, kaip efektyviai peržiūrėti tarpusavio kodą

  1. Apžvalga mažiau nei 400 eilučių kodas tuo momentu.
  2. Neskubėk.
  3. Nereikia apžvalga ilgiau nei 60 minučių vienu metu.
  4. Nustatykite tikslus ir fiksuokite metrikas.
  5. Autoriai turėtų nurodyti šaltinį kodas prieš apžvalga .
  6. Naudokite kontrolinius sąrašus.
  7. Nustatykite aptiktų defektų pašalinimo procesą.

Panašiai, kada turėtumėte atlikti kodo peržiūrą?

Kada reikia peržiūrėti kodo apžvalgas turėtų įvykti sėkmingai užbaigus automatines patikras (testus, stilių, kitą KI), bet prieš tai kodas susijungia su saugyklos pagrindinės linijos šaka. Mes paprastai nevykdome formalių pasirodymų kodo peržiūra bendrų pokyčių nuo paskutinio leidimo.

Be to, kaip „Google“atlieka kodo peržiūras? Norėdami parodyti savo sugebėjimus peržiūros kodas skaitomumui, kūrėjai adresu Google eiti per „ apžvalga jų kodo peržiūra praktikos“. Todėl kūrėjas pateikia kodas keičiasi skaitymo ekspertų komanda. Jie apžiūrės kodas . Tačiau šis patikrinimas nėra įprastas kodo peržiūra.

Taip pat kyla klausimas, kaip koduoti kaip žmogaus apžvalgą?

Technikai

  1. Leiskite kompiuteriams atlikti nuobodžias dalis.
  2. Išspręskite stiliaus argumentus naudodami stiliaus vadovą.
  3. Nedelsdami pradėkite peržiūrą.
  4. Pradėkite aukštą lygį ir eikite žemyn.
  5. Būkite dosnūs su kodų pavyzdžiais.
  6. Niekada nesakyk „tu“
  7. Pateikite atsiliepimus kaip prašymus, o ne komandas.
  8. Pastabas siekite su principais, o ne nuomone.

Kas yra gera kodo peržiūra?

Geri kodų atsiliepimai užduokite atvirus klausimus, užuot teikę tvirtus ar nuomonę pagrįstus teiginius. Jie siūlo alternatyvas ir galimus sprendimus, kurie galėtų geriau veikti pagal situaciją, nereikalaujant, kad tokie sprendimai yra geriausia arba vienintelis būdas tęsti.

Rekomenduojamas: