این مقاله درباره

کد ریویو چیست

کد ریویو چیست: خواندن نیت تغییر قبل از ادغام. چرا برای جونیور حیاتی است، چک‌لیست عملی، تفاوت با دیباگ و نقش منتور در حلقه بازخورد.

کد ریویو چیست؟ بازخورد عملی برای رشد برنامه‌نویس

نوشته شده توسط محمد اصل زنجانی

بازبینی‌شده توسط روبینش

اولین نظر را بدهید — امتیاز خوانندگان روبینش

اگر می‌پرسید کد ریویو چیست، یعنی انسان دیگری قبل از ورود تغییر به شاخهٔ اصلی، کد را می‌خواند تا بفهمد چه می‌کند، آیا با قرار تیم می‌خواند، و آیا یادگیری در آن هست — نه فقط اینکه «سبز است و اجرا می‌شود». ریویو جایگزین تست خودکار نیست. جایگزین منتور هم به‌تنهایی نیست، اما برای برنامه‌نویس تازه‌کار یکی از سریع‌ترین حلقه‌های بازخورد واقعی است.

جست‌وجوهایی مثل «کد ریویو چیست»، «چرا برای جونیور مهم است»، «چک‌لیست ریویو»، «تفاوت با دیباگ» و «نقش منتور» از تیمی می‌آید که یا ریویو ندارد و باگ دیر دیده می‌شود، یا ریویو دارد ولی به دعوای سلیقه تبدیل شده. در این راهنما هدف ریویو، چک‌لیست عملی، مرز با دیباگ و نقش منتور را جدا می‌کنیم. مسیر مهارت در نقشه راه برنامه‌نویس شدن و رابطهٔ رشد در منتورینگ برنامه‌نویسی است. همراهی تمرینی در خدمات منتورینگ روبینش.

Code review is a process of having another engineer review your code before it is merged. The primary purpose is to make sure that the code is of sufficient quality and that it does what it is supposed to do.

منبع: Google Engineering Practices — Code Review
بازبینی پول‌ریکوئست روی لپ‌تاپ: دیف کد و نظر همکار قبل از ادغام — روبینش | Rubinesh
ریویو خوب نیت را می‌پرسد؛ ریویو بد فقط فاصلهٔ آکولاد را می‌گیرد.

کد ریویو چه مسئله‌ای را حل می‌کند؟

تغییر کد دو مخاطب دارد: ماشین و انسان بعدی. تست به ماشین کمک می‌کند. ریویو به انسان کمک می‌کند بفهمد چرا این مسیر انتخاب شده، کجا ریسک است، و آیا نام‌ها و مرز ماژول قابل نگهداری‌اند. تیمی که فقط نویسنده کد را می‌فهمد، با رفتن او فلج می‌شود. ریویو دانش را پخش می‌کند. برای جونیور، دیدن اینکه یک تغییر چطور خوانده می‌شود از ده آموزش انتزاعی مؤثرتر است.

ریویو کیفیت را به «سلیقهٔ ارشد» تقلیل ندهید. قرار تیم را بنویسید: امنیت ورودی، لاگ، تست برای مسیر اصلی، اندازهٔ تغییر. اگر قرار نیست، هر نظر یک قانون لحظه‌ای است و منتی دفاعی می‌شود. ریویوکننده باید بین نقص واقعی، پیشنهاد اختیاری و سؤال برای فهم تفاوت بگذارد. مخلوط کردن این سه، جلسه را شخصی می‌کند.

اندازهٔ تغییر مهم است. ده فایل نامرتبط در یک درخواست، ریویو را سطحی می‌کند. بهتر است کار را بشکنید. نویسنده قبل از درخواست، توضیح بدهد چه مسئله‌ای حل شده و چگونه آزموده. بدون این توضیح، ریویوکننده حدس می‌زند و زمان دو طرف می‌سوزد. این عادت همان چیزی است که منتور در پروژهٔ واقعی باید تمرین بدهد، نه فقط در کلاس.

چرا برای برنامه‌نویس تازه‌کار این حلقه حیاتی است؟

جونیور معمولاً نمی‌داند چه چیزی را نمی‌داند. اجرای موفق محلی حس تمام‌شدن می‌دهد. ریویو نشان می‌دهد حالت خالی، دسترسی، نام‌گذاری یا تکرار منطق کجا پنهان است. اگر بازخورد با نمونه و دلیل بیاید، الگوی ذهنی عوض می‌شود. اگر فقط «اینو عوض کن» باشد، تقلید کور می‌سازد. لحن باید مستقیم و محترمانه باشد؛ تمسخر سرعت یادگیری را می‌کشد.

ترس از ریویو طبیعی است. منتور باید اول چند ریویو را با هم بخواند تا منتی ببیند نظر سخت به معنی بی‌ارزشی فرد نیست. بعد منتی خودش روی کد دیگران نظر بدهد؛ خواندن کد دیگران مهارت جداست. تیمی که جونیور فقط نویسنده است و هرگز ریویو نمی‌کند، یک طرف رابطه را تمرین نداده. حتی نظر کوچک روی تست یا نام متغیر شروع است.

در مسیر شغلی، نمونهٔ ریویو در گیت‌هاب بهتر از فهرست مهارت در رزومه حرف می‌زند. توضیح در درخواست ادغام، پاسخ به نظرها، و تغییر بعد از بازخورد، نشانهٔ کار تیمی است. جزئیات ارائهٔ کار را می‌توانید در مسیر فریلنسری برنامه‌نویسی هم ببینید؛ اینجا روی خودِ حلقهٔ بازخورد فنی می‌مانیم.

چک‌لیست ریویو چه چیزهایی را باید بپوشاند؟

چک‌لیست جلوی فراموشی موارد تکراری را می‌گیرد تا بحث روی منطق بماند. موارد پایه: آیا تغییر با توضیح همخوان است؟ آیا مسیر خطا دیده شده؟ آیا دادهٔ حساس لاگ می‌شود؟ آیا تست برای رفتار اصلی هست؟ آیا وابستگی جدید لازم است؟ آیا رابط کاربری یا قرارداد API بدون اطلاع مصرف‌کننده عوض شده؟ این فهرست را با زبان تیم خودتان کوتاه کنید؛ چک‌لیست بیست‌صفحه‌ای خوانده نمی‌شود.

لایه‌های نظر در یک ریویو سالم
لایه نمونه انتظار
باید اصلاح شود ورودی اعتبارسنجی نشده قبل از ادغام
پیشنهاد نام واضح‌تر برای تابع اختیاری با دلیل
سؤال چرا این ساختار داده؟ یادگیری دو طرف
چک‌لیست ریویو روی مانیتور: امنیت، تست و اندازه تغییر — روبینش | Rubinesh
قرار مکتوب، ریویو را از سلیقهٔ لحظه‌ای جدا می‌کند.

خودکارسازی را جایی بگذارید که ماشین بهتر است: فرمت، لینت، تست. ریویو انسان را برای معماری، امنیت معنایی و خوانایی نگه دارید. اگر ریویوکننده نیم ساعت فاصلهٔ ویرگول می‌گیرد، ابزار درست نصب نشده. زمان انسان گران است. منتور باید این تفکیک را به تیم کوچک هم یاد بدهد حتی اگر دو نفره باشند.

ریویو با دیباگ چه فرقی دارد؟

دیباگ پیدا کردن علت یک رفتار غلط در زمان اجراست: چرا این سفارش دو بار ثبت شد. ریویو خواندن تغییر قبل از ادغام است تا از ورود کلاس بزرگی از غلط‌ها و از کد غیرقابل فهم جلوگیری شود. گاهی در ریویو باگ پیدا می‌شود؛ هدف اصلی شکار همهٔ باگ‌ها نیست. اگر ریویو را جایگزین دیباگ حادثهٔ تولید کنید، هم دیر می‌رسید هم فضای سرزنش می‌سازید.

دیباگ اغلب فردی و فوری است. ریویو تعمداً کمی اصطکاک می‌گذارد تا کیفیت جمعی بماند. این اصطکاک باید کوتاه باشد. صف ریویو دو روزه برای تغییر کوچک، تیم را به دور زدن وادار می‌کند. قرار بگذارید تغییر اضطراری چطور با بررسی پس از ادغام جبران شود. بدون این مسیر، یا کیفیت می‌میرد یا سرعت.

دو نمایشگر: کنسول دیباگ در برابر صفحه ریویو کد — روبینش | Rubinesh
دیباگ گره را باز می‌کند؛ ریویو می‌پرسد چرا گره از اول خورده.

در آموزش، منتی را وادار نکنید بین «کد بزن تا کار کند» و «کد تمیز» یکی را انتخاب کند. اول مسیر را سبز کنید، بعد با ریویو لایهٔ خوانایی و حالت مرزی را اضافه کنید. دو مرحله در یک درخواست عظیم، بازخورد را قاطی می‌کند. همین نظم در پروژهٔ واقعی همان چیزی است که استخدام‌کننده می‌خواهد ببیند.

منتور در ریویو چه نقشی دارد؟

منتور الگوی نظر را می‌سازد: کوتاه، مشخص، با مثال. او نباید همهٔ خطوط را خودش بازنویسی کند وگرنه منتی نویسنده نمی‌ماند. بهتر است دو سه نکتهٔ پرتأثیر را انتخاب کند و بقیه را به ابزار یا ریویو بعدی بگذارد. سیل نظر روی یک درخواست اول، اعتماد را می‌شکند. پیشرفت را در درخواست‌های متوالی بسنجید نه در یک جلسهٔ ایده‌آل.

منتور ریویو را به جلسهٔ زنده وصل می‌کند: یک نظر مبهم را با هم باز می‌کنند، منتی توضیح می‌دهد، بعد خودش اصلاح را می‌نویسد. این حلقه از اصلاح خاموش روی شاخهٔ منتور عمیق‌تر است. اگر منتی فقط «پذیرفته شد» می‌زند بدون فهم، یادگیری رخ نداده. بخواهید در توضیح ادغام یک جمله بنویسد که چه قانونی یاد گرفته.

در تیم واقعی، منتور کمک می‌کند ریویو به گلوگاه قدرت تبدیل نشود؛ یعنی فقط یک نفر حق ادغام نداشته باشد که همه از او بترسند. چرخش ریویوکننده دانش را پخش می‌کند. برای استارتاپ دو نفره هم می‌توان از همکار دور یا منتور خارجی برای چند درخواست حساس استفاده کرد تا چشم دوم وجود داشته باشد.

چطور ریویو بخواهیم که جواب مفید بیاید؟

در توضیح درخواست، مسئله را از راه‌حل جدا کنید. «این تابع را بازنویسی کردم» کم است. «مهلت نشست روی موبایل قطع می‌شد، تست فلان اضافه شد، مورد مرزی آفلاین را نپوشاندم» ریویوکننده را هدایت می‌کند. اسکرین‌شات یا نمونهٔ ورودی برای باگ‌های ظاهری وقت را کم می‌کند. اگر بخشی آزمایشی است، همان را علامت بزنید تا نظر روی معماری موقت خرج نشود.

به نظرها در همان روز پاسخ بدهید حتی اگر پاسخ «بعداً در کارت جدا» باشد. سکوت صف را تلخ می‌کند. اگر مخالفید، دلیل با شرایط بگویید نه با دفاع از شخصیت. «در این مسیر سازگاری با API قدیم را ترجیح دادم چون مصرف‌کننده هنوز نسخه نداده» قابل بحث است. «سلیقه‌ات بد است» بحث نیست. جونیور حق سؤال دارد؛ پرسیدن نشانهٔ ضعف نیست. منتور باید این حق را در جمع عادی کند.

وقتی نظرها زیاد شد، آن‌ها را در سه دسته جمع کنید و در یک پیام اعلام کنید چه چیزی همین حالا عوض می‌شود. ریویوکنندهٔ خسته از دیدن بیست گفت‌وگوی پراکنده ممکن است تأیید سطحی بدهد. جمع‌بندی، کیفیت ادغام را بالا می‌برد. بعد از ادغام، یک خط در لاگ تیم بنویسید که چه الگویی را دیگر تکرار نمی‌کنید. این حافظهٔ تیمی همان ارزش ریویو است که ابزار لینت نمی‌دهد.

در تیم دورکار، ریویو جای گپ کنار میز را می‌گیرد. پس لحن نوشته باید کامل‌تر از حرف حضوری باشد. یک جملهٔ زمینه، یک پیشنهاد مشخص، یک لینک به قرار تیم. ایموجی کنایه و طعنه در متن ماندگار می‌ماند و جونیور آن را شب‌ها بازخوانی می‌کند. اگر بحث بالا گرفت، ده دقیقه تماس بهتر از بیست کامنت است. هدف ادغام سالم است نه برنده شدن در رشته نظر.

برای پروژهٔ آموزشی، ریویو را به تکلیف «درست کردن همهٔ نکات در یک شب» تبدیل نکنید. سه نکتهٔ اصلی کافی است تا عادت شکل بگیرد. بقیه را برای دور بعد بگذارید. پیشرفت را در درخواست سوم نسبت به اول بسنجید. اگر همان باگ null هر بار برگردد، تمرین هدفمند بگذارید نه سرزنش عمومی. منتور اینجا معلم است نه دروازه‌بان محصول.

امنیت را از سلیقه جدا کنید. نشت کلید، ورودی خام در کوئری، یا لاگ کردن رمز عبور الزام است حتی اگر «فعلاً محیط تست است». تست بودن عذر ماندگار می‌شود. یک فهرست کوتاه امنیتی روی قالب درخواست، جلوی فراموشی را می‌گیرد. ریویوکننده اگر فقط زیبایی نام متغیر را ببیند و تزریق را نبیند، حلقه شکست خورده است. ابزار اسکن کمک است اما جای خواندن مسیر حساس را نمی‌گیرد.

اشتباهات رایج در کد ریویو

  • درخواست‌های خیلی بزرگ
  • نظر بدون تفکیک الزام و پیشنهاد
  • بحث سلیقهٔ قالب به‌جای ابزار
  • سکوت جونیور از ترس
  • ادغام بدون توضیح مسئله
  • ریویو به‌عنوان تنبیه تأخیر

چک‌لیست شروع در تیم کوچک

  1. هر تغییر اصلی حداقل یک خواننده دارد.
  2. توضیح مسئله روی درخواست نوشته می‌شود.
  3. لینت و تست قبل از ریویو انسان اجرا می‌شوند.
  4. نظرها برچسب الزام یا پیشنهاد دارند.
  5. زمان انتظار ریویو سقف دارد.
  6. جونیور هم کد دیگران را می‌خواند.
  7. یک قانون نوشته‌شده برای امنیت و دادهٔ حساس هست.

جمع‌بندی: چشم دوم، نه دادگاه

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

برای تمرین ریویو روی پروژهٔ واقعی، صفحه منتورینگ و تماس با روبینش را ببینید. اگر تازه مسیر ورود به بازار را می‌چینید، اول نقشهٔ یادگیری را بخوانید و ریویو را از همان پروژهٔ تمرینی شروع کنید نه از روز استخدام. حتی یک همراهِ آموزشی که هفته‌ای یک درخواست را بخواند، از سال‌ها کدنویسی تنها با عادت‌های بسته بهتر است. ترس از دیده شدن کد را با درخواست‌های کوچک و توضیح روشن کم کنید تا حلقه زنده بماند. ریویو را نمایش مهارت نکنید؛ آن را عادت هفتگی کوتاه بگذارید تا کیفیت از تکرار بیاید نه از جلسهٔ نمایشی.

سؤالات متداول

کد ریویو جای تست خودکار را می‌گیرد؟

خیر. لینت و تست کار ماشین است. ریویو برای فهم نیت، ریسک و خوانایی است. اگر انسان فاصله ویرگول را بگیرد، ابزار درست نصب نشده.

جونیور فقط باید ریویو بگیرد یا خودش هم بخواند؟

هر دو. گرفتن بازخورد الگو می‌سازد؛ خواندن کد دیگران مهارت جداست. حتی نظر کوچک روی تست یا نام متغیر شروع است.

اگر تیم یک‌نفره است ریویو چطور انجام شود؟

یک همراهِ آموزشی یا همکار پاره‌وقت برای تغییرهای کوچک کافی است. درخواست را کوتاه بگیرید و توضیح مسئله را بالای تغییر بنویسید تا خواندن ممکن شود.

ریویو باید چند نفره باشد؟

برای تغییر معمولی یک خوانندهٔ دقیق بهتر از سه نظر سطحی است. تغییر حساس امنیتی یا قرارداد عمومی را با چشم دوم مشخص کنید، نه با صف طولانی.

تمرین ریویو را از کدام صفحه شروع کنیم؟

همراهی تمرینی در صفحه منتورینگ روبینش است. این مقاله هدف ریویو، چک‌لیست و مرز با دیباگ را پوشش می‌دهد.