همه ما میدانیم که بدون بازبینی کد (یک فعالیت تضمین کیفیت نرم افزار است) به جایی نخواهیم رسید و موفق نمیشویم. این کار کیفیت کد را بهبود میبخشد و ساختار کد را پایدارتر میکند. همچنین بازبینیها به برنامه نویسان برای ایجاد روابط و کار موثرتر کمک میکنند. با این حال، نمیتوان انکار کرد که بازبینی یک کد بسیار سادهتر از برنامه ریزی برای انجام همان کد است و چنین بازبینیهایی میتواند برای رهبران تیم یک کابوس باشد. در ادامه به معرفی ۹ تکنیک بازبینی کد از زبان Josef Cruz نویسندهی سایت Medium میپردازیم.
آشنایی با ۹ تکنیک بازبینی کد
اگر میخواهید کارآیی و اثربخشی کد را بهبود بخشید، شیوههای بازبینی کد را دنبال کنید.
۱. بیش از ۶۰ دقیقه یک کد را چک نکنید
کد را بیش از ۶۰ دقیقه در یک زمان چک نکنید زیرا، پس از یک ساعت کار دقیق، کارایی و توجه ما به جزئیات به میزان قابل توجهی کاهش مییابد. بهتر است کد را در بازهای بیشتر از حد معمول ولی در بخشهای کوتاهتر بازبینی کنید. چنین وقفهای به مغز شما فرصت بازیابی میدهد.
۲. بیش از ۴۰۰ خط از یک کد را به طور همزمان چک نکنید
تلاش برای مرور چندین خط کد به طور همزمان شانس یافتن خطاها را کاهش میدهد. سعی کنید از این موضوع مطمئن شوید که هیچ بخش بازبینی بیش از ۴۰۰ خط کد نیست. تعیین محدودیت برای خطوط کد به اندازه تعیین محدودیت زمانی اهمیت دارد. اگر این کار را انجام دهید، شما همیشه در بهترین حالت خود و با ذهنی “آزاد” خواهید بود.
۳. بدانید که هنگام بازبینی کد باید به دنبال چه چیزی باشید
هنگام جستجو در کد، خیلی مهم است که بدانید دقیقا به دنبال چه چیزی هستید. به دنبال موارد مهم مانند ساختار، منطق، پوشش دهی آزمایشها، خوانایی، قابلیت استفاده و عملکرد مناسب باشید.
شما میتوانید برخی موارد مانند: ساختار و منطق را به طور خودکار چک کنید، اما برخی دیگر، به عنوان مثال، عملکردها، همچنان به ارزیابی دقیق شما نیاز دارند. بازبینی کد به گونهای که برای سوالات خاص شما پاسخی داشته باشد، میتواند به شما در تمرکز بر روی موارد درست کمک کند. به عنوان مثال، میتوانید کد را در راستای سوالات زیر بررسی کنید:
- آیا متوجه میشوم که کد چه کاری انجام میدهد؟
- آیا کد انتظارات مورد نظرش را برآورده میکند؟
- آیا کد با الزامات قانونی مطابقت دارد؟
با بازبینی منتقدانه کد و در نظر داشتن سوالات بالا، آنچه که باید را در کد بازبینی کرده و زمان آزمایش را کاهش میدهید.
۴. کد را قبل از آزمایش دستی، خودتان ایجاد کنید و آزمایش کنید
در عصر یکپارچه سازی و ادغام مداوم، کلید عملکرد مناسب و صرفه جویی در زمان، ایجاد و آزمایش کد قبل از آزمایش دستی است.
پس از گذراندن آزمایشات، کد را بازبینی کرده و آن را در خط کد توسعه دهنده پیاده سازی کنید. بررسی عملکرد خودکار در خط اول، خطاهای احتمالی را کاهش داده و در زمان بررسی کد صرفه جویی میکند. اتوماتیک سازی همچنین از اتلاف وقت برای بررسی کد نیز جلوگیری میکند.
۵. نظرات بامعنی و هدفمندی ارائه دهید
سعی کنید خود را به شکل ارزشمندی معرفی کنید. سوال بپرسید، ولی قضاوت نکنید. فیدبک یا بازبینی شخصی مطمئناً به حفظ ارتباط خوب کمک میکند. کد شما همیشه نیاز به بازبینی دارد و شما همیشه باید کد همکار خود را بازبینی کنید. اگر بازبینی کد را به عنوان یک فرآیند یادگیری مشاهده کنید، همه برنده میشوند.
۶. اهداف و انتظارات را انتقال دهید
شما باید اهداف بازبینی کد را به طور واضح مشخص کنید و بدانید انتظارات منتقد از آن چیست. تحویل چک لیست به داور، انسجام بازبینی کد را تضمین میکند.
برنامه نویسان کد را بر اساس معیارهای یکسانی ارزیابی میکنند. همه افراد با انتقال اهداف و انتظارات در زمان خود صرفه جویی میکنند. داوران می دانند که باید به دنبال چه چیزی باشند و میتوانند از وقت خود برای بررسی درست و هوشمندانه کد استفاده کنند.
۷. همه افراد را در روند بازبینی کد شرکت دهید
صرف نظر از تجربه برنامه نویسان در تیم شما، همه باید بتوانند بازبینی کنند و بدانند که کد آنها نیز بازبینی میشود.
همه ما وقتی که میدانیم کسی کار ما را بازبینی میکند، بهتر کار میکنیم. بنابراین، هنگام انجام بازبینی کد، بهتر است که از یک برنامه نویس دیگر و یک طراح نرم افزار استفاده کنید.
شما مشکلات مختلفی را در کد، هم در مورد پایگاه کد جامعتر و هم در مورد پروژه محصول نهایی، کشف خواهید کرد. مشارکت همه افراد در فرایند بازبینی کد، همکاری و ارتباط بین برنامه نویسان را نیز بهبود میبخشد.
۸. برای ایجاد یک فرهنگ مثبت اقدام کنید
تقویت فرهنگ مثبت در روند بازبینی کد بسیار مهم است. بازبینی کد نقش مهمی در کیفیت محصول دارد. اهمیتی ندارد که چه کسی ابتدا این اشکال را انجام میدهد و اجرا میکند.
خطا باید در زمان مناسب پیدا شود. با ترویج فرهنگ مثبت، به کل تیم کمک میکنید تا از بازبینی کد استقبال هم کنند.
۹. اتوماتیک سازی را برای صرفه جویی در زمان اجرا کنید
قطعا مواردی وجود دارد که داوران هنگام بازبینی کد دستی، باید آنها را بررسی کنند. با این حال، برخی از این موارد را نیز میتوان به طور خودکار با استفاده از ابزارهای مناسب بررسی کرد.
به عنوان مثال، آنالیز کنندههای کدهای استاتیک، مشکلات احتمالی را در کد پیدا کرده و آنها را بر اساس قوانین کدنویسی بررسی میکنند. بنابراین، استفاده از آنالیز کنندههای استاتیک تعداد خطاهایی را که به مرحله بازبینی میرسند را به حداقل میرساند.
استفاده از قوانین بازبینی کد کم حجم نیز میتواند کمک کننده باشد. با استفاده از ابزارهای خودکار، میتوانید در ارزیابی یکدیگر، مقداری وقت صرفه جویی کنید.
کد شما همواره نیاز به بازبینی دارد. اما، اگر نکات بالا را رعایت کنید، همیشه این شانس وجود دارد که همیشه آنچه را که به دنبال آن هستید را پیدا کنید.
حال که با ۹ تکنیک بازبینی کد آشنا شدید میتوانید از دیگر مقالات سایت اول نیوز دیدن کنید.