کانال تلگرام

اشتباهات کدنویسی رایجی که باید از آنها جلوگیری کنید

تاریخ : ۱۷ تیر ۱۳۹۹
نویسنده : آروین سعادت نیا
دسته بندی ها : برنامه نویسی

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

commonmistakdev1

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

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

1. انجام همه کارها در یک تابع

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

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

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

2. قرار داشتن بلوک های کامنت شده کد در برنامه

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

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

3. نامگذاری غیر توصیفی برای متغیرها در برنامه

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

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

4. استفاده از اعداد نامفهوم

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

for ($i = 1; $i <= 52; $i++) {
    ...
}

در مثال بالا عدد 52 یک عدد نامفهوم است، هیچکس نمیداند که چرا عدد 52 در اینجا قرار گرفته است و واقعا چرا 52؟ برای مثال چرا از عدد 64 در اینجا استفاده نکرده ایم، در این گونه موارد بهتر است این نوع مقادیر را در یک متغیر با معنی قرار دهیم. برای نمونه :

$cardDeckSize = 52;
for ($i = 1; $i <= $cardDeckSize; $i++) {
    ...
}

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

4. استفاده از فرمت بندی نامناسب برای کدها

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

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

5. بهرگیری از کدنویسی سخت

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

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

اطلاعات مقاله


تاریخ انتشار : ۱۷ تیر ۱۳۹۹
نویسنده : آروین سعادت نیا
اشتراک گذاری در :

مقالات پیشنهادی

مشاهده همه مقالات
ثبت دیدگاه

برای ارسال دیدگاه لازم است ابتدا وارد سایت شوید