چگونه یک قطعه کد را برای توضیح یا بازبینی ارسال کنیم؟
دامنه را محدود کنید تا بین مشاهده کد و نتیجه‌گیری‌های اجرایی در پاسخ تمایز قائل شوید.
محدود کردن دامنه کد
ابتدا تابع یا قطعه مربوطه را برای بازبینی ارائه دهید، زبان، روش فراخوانی و رفتار مورد انتظار را مشخص کنید. اگر مشکل به پیکربندی، فرمت ورودی یا توابع دیگر بستگی دارد، حداقل زمینه لازم را شامل کنید. به وضوح بیان کنید که آیا می‌خواهید جریان کنترل، شرایط مرزی یا مسائل بالقوه را درک کنید تا از گسترش پاسخ به یک چک لیست عمومی برای کل پروژه جلوگیری شود.
اهداف مشخص بازبینی را ارائه دهید
شما می‌توانید بنویسید "توضیح دهید که این تابع چگونه ورودی خالی را مدیریت می‌کند و موارد مرزی را که نیاز به آزمایش دارند، مشخص کنید." اگر پیشنهادات اصلاح را می‌خواهید، توضیحات دلایل و تأثیر مورد انتظار را درخواست کنید. هنگام چسباندن کد مستقیماً یا ارائه آن از طریق پیوست‌های موجود، همیشه تورفتگی و نام فایل‌ها را بررسی کنید؛ کلیدها یا اسرار واقعی را برای راحتی در مواد گنجانده نکنید.
- کد مربوطه، زبان و نتایج مورد انتظار را ارائه دهید.
- رفتار واقعی یا نگران‌کننده‌ترین خطرات را توصیف کنید.
- درخواست کنید که یافته‌ها، پیشنهادات و روش‌های تأیید به طور جداگانه فهرست شوند.
تأیید کنید که کدام مراحل بازبینی تکمیل شده‌اند
نتیجه‌گیری‌هایی که صرفاً از خواندن کد به دست می‌آیند، تحلیل ایستا محسوب می‌شوند و به این معنی نیست که آزمایش‌ها اجرا شده‌اند. اگر پاسخ ادعا می‌کند که برنامه اجرا شده است، خروجی‌های ابزار مربوطه را بررسی کنید؛ اگر محیط در دسترس نیست، فهرستی از بخش‌های تأیید نشده را بخواهید. قبل از پذیرش اصلاحات، رفتار باید همچنان در یک محیط مناسب بررسی شود، به ویژه اطمینان حاصل شود که هم ورودی عادی و هم مدیریت خطا انتظارات را برآورده می‌کنند.