۵ درسی که من در مورد نحوه ساختار کد آموخته‌ام

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

اهمیت ساختار را نباید دست کم گرفت زیرا ساخت کد از نظر خوانایی و قابلیت نگهداری بسیار مهم است.

درس اول در ساختار کد : طراحی

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

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

نمودارهای UML که ایجاد کرده‌اید به شما این امکان را می‌دهد که اجازه ندهید افکار شما دور شود یا برخی از ویژگی‌های غیر ضروری را که فکر می‌کنید در آینده مفید هستند اضافه کنید.

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

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

درس دوم: قرارداد‌های کد

بخش عمده‌ای از ساختار کد شما مربوط به قراردادهای کد است. قراردادهای‌ کد برای هر پروژه‌ای ضروری است. بدون قراردادهای برنامه نویسی، کد شما در مدت زمان طولانی به یک ظرف غذا غیرقابل خواندن تبدیل می‌شود.

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

پس از دریافت این لیست، به آن پایبند باشید!

درس سوم: دستورالعمل‌ها برای کلاس و توابع

برای اینکه کلاس‌ها و توابع شما قابل خواندن و نگهداری باشند، چند راه وجود دارد که می‌توانید دنبال کنید:

1. کلاس‌ها و توابع را کوچک نگه دارید
2. اجازه دهید کلاس‌ها و توابع از اصل مسئولیت واحد (SRP) پیروی کنند

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

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

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

درس چهارم: استفاده از دیزاین پتر‌ن‌ها

یادگیری در مورد الگوهای طراحی و نحوه کار آن‌ها راهی عالی برای کمک به ساختار کدهای شما و نوشتن کدهای قابل خواندن و نگهداری است.

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

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

درس پنجم از نحوه ساختار کد: نوشتن یونیت تست

نوشتن یونیت تست دارای اثر جانبی بسیار خوبی است که شما را مجبور به ساختار درست کد می‌کند. برای اینکه بتوانید یونیت تست را برای کد خود بنویسید، باید کد شما ساختار درستی داشته باشد.

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

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

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

نتیجه گیری

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

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

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

منبع