Як прадставіць фрагмент кода для тлумачэння або агляду?
Сфакусуйце абсяг, каб адрозніць назіранне за кодам ад высноў па выкананні.
Абмяжуйце абсяг кода
Спачатку прадастаўце функцыю або адпаведны фрагмент для агляду, указваючы мову, метад выкліку і чаканае паводзіны. Калі праблема залежыць ад канфігурацыі, фармату ўводу або іншых функцый, уключыце мінімальна неабходны кантэкст. Ясна ўкажыце, ці хочаце вы зразумець паток кіравання, мяжовыя ўмовы або патэнцыйныя праблемы, каб адказаць не ператварыўся ў агульны кантрольны спіс для ўсяго праекта.
Прадастаўце канкрэтныя мэты агляду
Вы можаце напісаць: «Тлумач, як гэтая функцыя апрацоўвае пусты ўвод і пазнач мяжовыя выпадкі, якія патрабуюць тэсціравання». Калі вы хочаце прапановы па змене, запытайце тлумачэнні прычын і чаканага ўплыву. Устаўляючы код непасрэдна або прадастаўляючы яго праз даступныя прымацаванні, заўсёды правярайце водступы і назвы файлаў; не ўключайце сапраўдныя ключы або сакрэты ў матэрыялы для зручнасці.
- Прадастаўце адпаведны код, мову і чаканыя вынікі.
- Апішыце фактычныя паводзіны або найбольш трывожныя рызыкі.
- Запытайце асобнае пералічэнне высноў, прапаноў і метадаў праверкі.
Пацвердзіце, якія крокі агляду былі выкананы
Высновы, зробленыя выключна на аснове чытання кода, з'яўляюцца статычным аналізам і не азначаюць, што тэсты былі выкананы. Калі ў адказе сцвярджаецца, што праграма была запушчана, праверце адпаведныя вывады інструментаў; калі асяроддзе недаступнае, запытайце спіс неправераных частак. Перад прыняццем змен паводзіны павінны быць правераны ў адпаведным асяроддзі, асабліва пераканаўшыся, што як звычайны ўвод, так і апрацоўка памылак адпавядаюць чаканням.