نکاتی با ارزش برای نوشتن کد با کیفیت و سطح بالا در سی شارپ
- برای خودتان یا تیمتان قواعد نام گذاری تعریف کنید و بر اساس آن کدها را بنویسید، برای مثال، خیلی از افراد برای نام گذاری field ها از کاراکتر __ در ابتدای نام گذاری استفاده کرده و خیلی ها خیر. مکانیزم های نام گذاری PascalCase و CamelCase را رعایت کنید، مخصوصاً برای نام گذاری کلاس ها، متغیرها و پارامترها.
- قبلاً در انجمن در مورد قواعد SOLID مطلبی ارسال کردم. حتماً با این قواعد آشنا شوید و در کد خود آن ها را رعایت کنید.
- از نوشتن کدهای تکراری خود داری کنید. اصطلاحا وجود Duplication در کد، فاجعه به حساب می آید. کدها باید به نحوی نوشته شوند که قابلیت Reusablity داشته باشند. می توانید برای شرایط خاص متدها و کلاس های generic تعریف کنید و در قسمت های مختلف از آن ها استفاده کنید. همچنین برای رابط کاربری سعی کنید User Control ایجاد کرده و در قسمت های مختلف از آن ها استفاده کنید.
- سعی کنید یکپارچگی را در کد خود حفظ کنید، اینکه در قسمتی از برنامه از int و در قسمتی دیگر از Int32 برای تعریف متغیر استفاده کنید اصلاً جالب نیست.
- سطوح دسترسی به بخش های کد باید به درستی رعایت شود، شاید کلاسی باید به صورت internal تعریف شود و نه به صورت public، نسبت به این موضوع دقت کافی داشته باشید.
- در قسمت هایی که باید ارتباط بین کدها به حداقل برسد، حتماً از interface ها استفاده شود. آشنایی با مفاهیم DI و IoC به شدت به شما در این زمینه کمک می کند.
- زمانی که کلاس ها از هم ارث بری می کنند، به درستی از کلمات کلیدی abstract و sealed استفاده کنید.
- استفاده از اعضاء static، مخصوصاً در برنامه های تحت وب به شدت خطرناک است و می تواند تاثیر زیادی در ایجاد مشکل در کد شما داشته باشد. در صورت استفاده از اعضاء static، حتماً مکانیزم های synchronization را در نظر بگیرید.
- در صورتی که به صورت تیمی کار می کنید و یک Library برای تیم نوشته شده است، حتماً برای آن متد XML Documentation ایجاد کنید.
- از فیلد های read-only و همچنین متغیرهای constant به درستی استفاده کنید.
