برنامه نویسی

یک رویکرد عملی در نوشتن کد تمیز

من فکر می کنم کد پاک بسیار مورد نظر است. و، بسته به اینکه چه کسی به آن نگاه می کند، ممکن است یک قطعه کد “پاک تر” به نظر برسد.

در یک تیم با افرادی با پیشینه‌های مختلف روبرو می‌شوید که «حس» از ظاهر «کد تمیز» را ایجاد کرده‌اند.

IMO 3 مرحله اصلی دارد که کد باید طی شود:

  • کد باید همانطور که انتظار می رود کار کند.
  • کد باید مقیاس باشد.
  • کد باید قابل خواندن (پاک) باشد.

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

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

اگر کدی که نوشتم الزامات داده شده را برآورده کند، یک فشار git بی شرمانه انجام می دهم.

اگر مدتی باقی مانده باشد، برخی بهینه‌سازی‌های سرعت را انجام می‌دهم، سعی می‌کنم آن را تا حد امکان «خوانا» کنم، تقریباً «مانند یک داستان». من به دنبال نام متغیرهای خوب، کد مسطح و پایه، ظاهر “چشم‌پسند” خواهم بود. بعد از مدتی اگر دوباره با آن کد مواجه شدم مراحل قبلی را تکرار می کنم. کد به مرور زمان بهتر و بهتر می شود.

در یک پروژه وب جدید، ساختار اصلی MVC را ایجاد خواهم کرد. من با تعریف مدل ها / طرحواره ها شروع می کنم و به روابطی که رخ می دهد فکر می کنم.

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

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

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

سازنده ترین پشته فعلی من FastAPI، Jinja2 (با AlpineJs) و MongoDB است. با FastAPI به راحتی می توانید اسناد OpenAPI را بیش از انتظارات ایجاد کنید. عدم نگرانی در مورد پشته JS مختلف باعث می شود همه چیز سریعتر توسعه یابد. Jinja2 در تولید html از داده های سفارشی کار بسیار خوبی انجام می دهد. برای چیزهایی که Jinja نمی‌تواند در قسمت جلویی از پس آن برآید، از AlpineJs استفاده می‌کنم – بدون مرحله ساخت، استفاده ساده و به‌طور شگفت‌آور قدرتمند. از آنجایی که سئوی جایزه عالی است، نیازی به ادامه مسیریابی در باطن و فرانت اند + موارد دیگر نیست.

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

وسواس در مورد کدهای پاک برای هیچ کس فایده ای ندارد. داشتن یک رویکرد عمل گرایانه هنگام نوشتن نرم افزار IMO بسیار بهتر است و برای همه مفید است.

به مرور زمان با یا بدون یادگیری SOLID، KISS، DRY، الگوهای طراحی و غیره، همه به طور طبیعی کدهای تمیز می نویسند. یادگیری آن‌ها از قبل باعث سرعت بخشیدن به کارها می‌شود، اما استفاده از آنها یکی یکی و داشتن درک عمیق در عمل در مورد نحوه استفاده از آنها بهتر است.

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

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

نوشته های مشابه

دیدگاهتان را بنویسید

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

دکمه بازگشت به بالا