برای آینده پروژه مهم است که فایلهای کلاس به گونهای تنظیم شوند که خواندن آنها آسان باشد و به راحتی اصلاح شوند و به طور مداوم انجام شوند . ما این کار را برای جلوگیری از "کد اسپاگتی" که خواندن و تغییر آن سخت است و به توسعه دهندگان جدید یا بازبینان کد احساس خوبی در مورد پایداری پروژه نمی دهد، انجام می دهیم. این باید درست در ابتدای پروژه انجام شود و از طریق ابزارهای بررسی کد و تجزیه و تحلیل کد اعمال شود. اگر نه، تعمیر آن در آینده بسیار پرهزینه خواهد بود. در این مقاله، من دقیقا نحوه فرمت کردن کلاس های کد را با مثال نشان خواهم داد. از زمانی که یادم می آید کلاس ها را به این شکل قالب بندی می کردم. مطمئن نیستم چرا شروع کردم به این روش. فکر می کنم این را به طور طبیعی در طول زمان توسعه دادم.
برای مشاهده نمونههای بیشتر از نحوه قالببندی فایلهای کلاس من، مخزن Spargine را در https://bit.ly/Spargine بررسی کنید . اطلاعات این مقاله از کتاب من " تکثیر کد: استانداردهای کدگذاری برای مایکروسافت دات نت " موجود در آمازون است.
سر کلاس
ابتدا، اجازه دهید با آنچه باید در بالای هر فایل کلاس باشد، شروع کنیم. یک فایل، در بیشتر موارد، فقط باید یک نوع داشته باشد.
سرتیتر
در بالای هر فایل کلاس، یک هدر، بر اساس قانون StyleCop ، باید وجود داشته باشد که حاوی اطلاعات زیر است.
- نام مجمع
- نام نویسنده اصلی