سلام! به عنوان یک تامین کننده Reducer، مدت زیادی است که در انبوه بررسی کد برای کاهنده ها بوده ام. بررسی کد بسیار مهم است، چه یک کدنویس مبتدی یا یک حرفه ای باتجربه باشید. آنها به شناسایی اشکالات، بهبود کیفیت کد کمک می کنند و مطمئن می شوند که کاهنده های شما مانند یک جذابیت کار می کنند. بنابراین، من نکاتی را به اشتراک میگذارم که در طول سالها به کار گرفتهام تا روند بررسی کد شما را روانتر کنم.
1. اصول درونی را بشناسید
حتی قبل از شروع بررسی کد، باید درک کاملی از چیستی کاهش دهنده و نحوه عملکرد آن داشته باشید. کاهنده یک تابع خالص است که وضعیت فعلی و یک عمل را به عنوان ورودی می گیرد و یک حالت جدید برمی گرداند. ساده است، درست است؟ اما این مفهوم اساسی پایه و اساس همه چیز است. اگر در این مورد واضح نیستید، در پیچ و خم کد گم خواهید شد.
به عنوان مثال، فرض کنید شما در حال کار بر روی یکگیربکس دوبل کاهنده کرم. کد کاهنده آن باید از قوانین توابع خالص پیروی کند. نباید هیچ گونه عوارض جانبی مانند برقراری تماس های API یا تغییر متغیرهای خارج از محدوده خود داشته باشد. اگر کدی را مشاهده کردید که سعی میکند در طول بازبینی، کاری شبیه به آن انجام دهد، یک پرچم قرمز است.
2. خوانایی را بررسی کنید
کد قابل خواندن مانند یک داستان خوب نوشته شده است. دنبال کردن آن آسان است و نیازی نیست سر خود را خارانید تا بفهمید چه اتفاقی در حال رخ دادن است. هنگام بررسی کد کاهنده، به دنبال مواردی مانند نامگذاری مناسب متغیر باشید. به جای استفاده از متغیرهای تک حرفی مانندالفیاب، از نام های توصیفی استفاده کنید. به عنوان مثال، اگر با سرعت a سر و کار داریدگیربکس سیاره ای نما 23در کاهنده خود، متغیر را فراخوانی کنیدگیربکس سرعتنه فقطس.
به ساختار کد نیز توجه کنید. از تورفتگی به درستی استفاده کنید و در صورت طولانی شدن کد، آن را به توابع کوچکتر تقسیم کنید. یک تابع طولانی و یکپارچه برای خواندن و رفع اشکال دردناک است.
3. Edge Cases را تست کنید
موارد لبه آن سناریوهای کوچک یواشکی هستند که اغلب اتفاق نمیافتند، اما در صورت وقوع میتوانند باعث سردردهای بزرگ شوند. هنگام بررسی کد کاهنده، به تمام موارد لبه ممکن فکر کنید. برای مثال، اگر حالت ورودی باشد، چه اتفاقی میافتدتهییاتعریف نشده? یا اگر عمل فرمت غیرمنتظره ای داشته باشد چه؟
فرض کنید شما در حال کار بر روی کاهنده برای یکگیربکس سیاره ای با دقت بالا. باید آزمایش کنید که گیربکس وقتی گیربکس به حداکثر یا حداقل سرعت خود می رسد چگونه رفتار می کند. آیا این موقعیتها را به خوبی مدیریت میکند، یا خراب میشود؟
4. به دنبال کد تکراری باشید
تکرار کد مانند یک ویروس در پایگاه کد شماست. نگهداری کد را سختتر میکند و میتواند منجر به باگ شود. هنگام بررسی کد کاهنده، مراقب قسمت هایی از کد که تکرار می شوند باشید. اگر می بینید که از یک منطق در چندین مکان استفاده می شود، آن را به یک تابع جداگانه تغییر دهید.
به عنوان مثال، اگر کدی دارید که گشتاور یک گیربکس را در دو قسمت مختلف کاهنده محاسبه می کند، بهتر است یک تابع واحد برای آن محاسبه ایجاد کنید و آن را از هر دو مکان فراخوانی کنید.
5. بررسی Error Handling
رسیدگی به خطا در کد کاهنده بسیار مهم است. شما هرگز نمی دانید چه چیزی ممکن است اشتباه پیش برود، بنابراین باید مطمئن شوید که کد می تواند به خوبی خطاها را مدیریت کند. به دنبال مکانیسمهای مربوط به تلاش - گرفتن بلوکها یا سایر خطاها - مکانیزمهای مدیریت در کد بگردید.
به عنوان مثال، اگر کاهنده بر اساس برخی از داده های سنسور از گیربکس محاسبه کند، اگر داده های سنسور خراب شود چه اتفاقی می افتد؟ کد باید راهی برای مدیریت این وضعیت بدون از کار انداختن کل سیستم داشته باشد.
6. اطمینان از عملکرد
عملکرد مهم است، به خصوص در هنگام برخورد با کاهنده ها. شما نمی خواهید کاهنده شما یک گلوگاه در برنامه شما باشد. هنگام بررسی کد، به دنبال عملیاتی باشید که ممکن است از نظر محاسباتی گران باشد.
برای مثال، اگر کاهنده حلقه های تودرتو یا محاسبات پیچیده زیادی را روی مجموعه داده های بزرگ انجام دهد، ممکن است برنامه را کند کند. سعی کنید این عملیات را بهینه کنید یا الگوریتم های کارآمدتری پیدا کنید.
7. استانداردهای کدگذاری را دنبال کنید
هر تیم یا پروژه معمولاً مجموعه ای از استانداردهای کدنویسی خاص خود را دارد. مطمئن شوید که کد کاهنده از این استانداردها پیروی می کند. این شامل مواردی مانند نامگذاری قراردادها، قالب بندی کد و اظهار نظر می شود.
استانداردهای یکنواخت کدگذاری، درک و نگهداری از پایگاه کد را آسان تر می کند. اگر همه اعضای تیم از قوانین یکسانی پیروی کنند، مثل این است که به یک زبان صحبت می کنند.
8. بررسی و همکاری همکاران
از درخواست نظر دوم نترسید. بررسی همتایان راهی عالی برای دریافت چیزهایی است که ممکن است از دست داده باشید. از یک توسعه دهنده دیگر بخواهید که به کد نگاه کند و افکار خود را به اشتراک بگذارد.
شما همچنین می توانید در مورد کد بحث کنید. شاید راه بهتری برای پیاده سازی یک ویژگی خاص یا رسیدگی به یک edge case وجود داشته باشد. همکاری می تواند منجر به کد بهتر و کاهش دهنده قوی تر شود.
9. مستندات
اسناد خوب مانند یک نقشه برای کد شما هستند. این به توسعه دهندگان دیگر (و حتی خودتان در آینده) کمک می کند تا بفهمند کد چه کاری انجام می دهد. هنگام بررسی کد کاهش دهنده، بررسی کنید که آیا نظراتی وجود دارد که هدف توابع و متغیرهای مختلف را توضیح می دهد.
به عنوان مثال، اگر عملکردی در کاهنده وجود داشته باشد که نسبت دنده یک گیربکس را تنظیم می کند، باید یک نظر توضیح دهد که چگونه کار می کند و چه ورودی هایی را انتظار دارد.
10. به یادگیری ادامه دهید
دنیای برنامه نویسی دائماً در حال تحول است و بهترین روش ها برای بررسی کد نیز همینطور است. با آخرین روندها و تکنیک ها به روز باشید. وبلاگ ها را بخوانید، در کنفرانس ها شرکت کنید و به انجمن های توسعه دهندگان بپیوندید.
به عنوان یک تامین کننده Reducer، من می دانم که داشتن کد با کیفیت بالا برای محصولاتمان چقدر مهم است. با پیروی از این نکات بررسی کد، می توانید اطمینان حاصل کنید که کاهنده های شما قابل اعتماد، کارآمد و نگهداری آسان هستند.
اگر در بازار کاهنده ها هستید یا در مورد محصولات ما سؤالی دارید، مایلم با شما گپ بزنم. این که آیا شما علاقه مند بهگیربکس دوبل کاهنده کرم،گیربکس سیاره ای نما 23، یاگیربکس سیاره ای با دقت بالا، با خیال راحت تماس بگیرید. ما می توانیم در مورد نیازهای خاص شما صحبت کنیم و راه حل مناسبی برای شما پیدا کنیم.
مراجع
- "کد پاک: کتابچه راهنمای کاردستی نرم افزار چابک" نوشته رابرت سی. مارتین
- انجمن ها و انجمن های برنامه نویسی آنلاین برای توسعه کاهش دهنده ها
