چگونه به شکلی حرفه‌ای دست به Code Review بزنیم؟

چگونه به شکلی حرفه‌ای دست به Code Review بزنیم؟

Code Review (بررسی کد) معمولاً باعث می‌شود سرعت برنامه‌نویس برای ایجاد تغییر در سورس‌کد کند شود؛ اما درعین‌حال، بررسی کد فرصتی برای اصلاح کدها و یادگیری از سایر دولوپرهای باتجربه و حرفه‌ای است. اما چگونه می‌توان از این فرصت، حداکثر بهره‌برداری را داشت؟ برای یافتن پاسخ به این سؤال، در ادامه با سکان آکادمی همراه باشید.

زمان بررسی کد (Code Review) خود را با هوشیاری و دقت مدیریت کنید؛ دقت کنید درصورتی‌که به موارد وقت‌گیری که بی‌دلیل شما را گرفتار می‌کنند بپردازید، عملاً برآیند بهره‌وری تیم خود را کاهش می‌دهید. اما قبل از این‌که نتایج بررسی کد را اعلام کنید، به این موارد دقت کنید:

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

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

- به دیدگاه افراد دیگر پیرامون معماری پروژه همواره اهمیت دهید: اگر موردی وجود دارد که نسبت به آن مطمئن نیستید، از دیگران نظرخواهی کنید چراکه ممکن است دیگر دولوپرها با مشکلاتی که هم‌اکنون شما به دست‌وپنچه با آن‌ها می‌پردازید، در گذشته برخورد کرده و راه‌کارهای خوبی هم به‌دست آورده باشند.

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

- اطلاعات مهم را در خود سورس‌کد قرار دهید: ممکن است شخصی که کد شما را در آینده می‌خواند، تمایلی به خواندن گزارش نهایی Code Review نداشته باشد؛ پس در همین راستا، اطلاعات کلیدی را در قالب کامنت در خود سورس‌کد بنویسید.

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

- علت پشت پردهٔ کدها را جویا شوید: درصورتی‌که علت مرتبط با کدی را متوجه نمی‌شوید، در سورس‌کد تغییر ایجاد نکنید و سعی کنید اگر به دولوپر پروژه دسترسی دارید از وی سؤال نمایید و در غیر این‌ صورت، به مستندات پروژه مراجعه نمایید. 

منبع