فهرست بستن

۱۰ نکته برای اینکه کد نویسی صحیح و مرتبی داشته باشید

correctly-code-12

چرا  این مطلب که کد نویسی صحیج و مرتبی داشته باشید اهمیت دارد. کد نویسی مرتب باعث صرفه جویی در زمان می شود،نگهداری آن را راحت تر میکند و برنامه نویسانی که در آینده ممکن است کد شما را بررسی کنند بهتر می توانند آن را درک کنند.

اصطلاح Spaghetti Code را حتما شنیده اید. این اصطلاح به کدهایی اطلاق می شوند که ساختار پیچیده و درهمی دارند و همانند یک ظرف اسپاگتى در هم تنیده و پیچیده هستند.  با این حال به یاد داشته باشید در رویاروی با مشکلات و حل آن، “پیشگیری همیشه بهتر از درمان است”.

در زیر به بررسی ۱۰ نکته خواهیم پرداخت که چگونه کدنویسی مرتبی داشته باشیم.

نکات ضروری هنگام نوشتن کد:

۱. شما مسئول هستید

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

۲. از نام های معنی دار استفاده کنید

نام  متغیر ها نباید رمزی باشند. به عنوان مثال به جای استفاده از متغیری به نام ۱ $D از نام هایی چون days_since_start و یا elapsed_days استفاده کنید.  اگر بدین شکل عمل کنید ، بعدا در هنگام ویرایش کدها، هفته بعد، ماه بعد و یا حتی سال بعد،با یک نگاه خواهید فهمید که این متغییر به چه چیزی اشاره می کند.

۳. قطعه کدهای شما باید به گونه ای باشند که قصد و هدف خود را نشان دهند

محتویات کدهای شما باید به گونه ای باشد که هدف را توضیح دهند. یرای مثال همانطور که گفته شد نامگذاری بخش ها باید به گونه ای باشد که پروسه در حال انجام را تشریح کند.  به عبارت دیگر، کدنویسی شما باید همانند یک نثر خوب باشد.

۴.در اغلب موارد کامنت ها در مورد پروسه در حال انجام دروغ می گویند.

با اینکه کامنت ها بسیار مهم هستند، اما تا آنجایی که امکان دارد خود کد باید خودش را توضیح دهد. با این حال  کامنتهایتان باید همانند کدنویسیتان واضح باشد، ضمن اینکه نباید کاملا به کامنت ها تکیه کنید. در نظر داشته باشد این بدین معنی نیست که از کامنت ها استفاده نکنید،در عوض کدهای مرتب، نیاز به کامنت های کمتری دارند.

۵.کدهایتان را یک بار دیگر مرتب کنید

جدا از آنکه کدهایتان را مرتب می نویسید، زمانی را  برای بررسی و مرتب سازی دوباره آن صرف کنید. این کار بدین معنی است که می توانید کدهایتان را مرتب تر کنید و بخش های اضافی را اصلاح کنید.

۶. از قانون تک وظیفه ای پیروی کنید

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

۷. تست و بررسی مجدد

از دو روش برای تست کدهایتان می توانید استفاده کنید : تست  مجزا و تست یکپارچه

تست های واحد عملکرد اجزا را به صورت جداگانه بررسی می کنند. تست های بکپارچه برای اطمینان ازین مطلب است که اگر در این بخش تغییری ایجاد شود نباید بخشهای دیگری بهم بریزد.  برنامه نویسی مبتنی بر تست رویکردی است که باعث می شود شما مطمئن شوید تست ها مناسبند و می توانند به مرتب شدن کدهای شما کمک کنند.

۸. زمان بندی و چابک سازی

بصورت مداوم  و طولانی برای ۶ ماه کار نکنید.  در عوض کارها را به بخش های کوچکتر تقسیم کنید و  بر روی بخش های مختلف  بصورت مجزا و مستقل کار کنید و در برخی اوقات تست هایی را انجام دهید. مهم تر اینکه به سنت ادامه انجام کار متعهد باشید.

۹. معماری مستقلی داشته باشید

روش ها ی مناسبی وجود دارد که از طریق فریم ورک های مختلف قابل اعمال هستند. نسبت به روش یا معماری خاصی تعصب نداشته باشد. یک ایده خوب را زمانی که مناسب باشد می توان در موقعست های مختلف استفاده کرد

۱۰. تمرین ، تمرین  و  تمرین

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

این نکات برای داشتن یک کدنویسی درست و مرتب شروع خوبی هستند و منابعی بسیاری هم برای بهینه سازی تکنیک های کد نویسی وجود دارد.

منبع: ایران هاست

پاسخی بگذارید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *