نکاتی با ارزش برای نوشتن کد با کیفیت و سطح بالا در سی شارپ
- یکی از خطرناک ترین کارها، کپی کردن کد از سایر منابع است. سعی کنید تا حد امکان کد مورد نظر توسط خودتان یا اعضاء تیم نوشته شود تا بعدها برای تغییر آن کد دچار مشکل نشوید. (در اینجا منظورم استفاده از Component ها و ابزارهای آماده نیست).
- برنامه باید توسط ابزارهای Memory Profiler بررسی شود تا مشکلات احتمالی برنامه در مورد حافظه شناسایی شود.
- قسمت هایی از برنامه که با بانک اطلاعاتی در ارتباط است، در صورت عدم استفاده از ORM ها، حتماً مقادیر باید با استفاده از Parameter ها به Query ها ارسال شوند، نه به صورت مستقیم داخل رشته.
- طمئن شوید که پروژه شما هیچ اخطاری ندارد. شما می توانید لیست warning ها را از پنجره error list مشاهده کنید و نسبت به برطرف کردن آن ها اقدام کنید.
- سعی کنید همیشه عملیات Code Analysis را بر روی کدهای خود اجرا کنید. ابزارهای زیادی در این زمینه وجود دارند، هم خود Visual Studio به شما امکان انجام Code Analysis را می دهد و هم می توانید از ابزارهای جانبی استفاده کنید. یکی از بهترین ابزارهای موجود Resharper است که می توانید اصول و قواعد را نیز برای انجام Code Analysis در آن تعریف کنید.
- در تمامی قسمت های برنامه که امکان ارسال مقادیر null برای پارامترها وجود دارد، باید عملیات Null Checking انجام شود تا از بروز خطای NullReferenceException جلوگیری شود.
- کد خود را به نحوی بنویسید که قابل خواندن باشد. منظورم از قابل خواندن انتخاب نام مناسب برای متغیر ها، کاهش حلقه ها، کاهش if ها و خیلی از موارد دیگر است که می تواند به بالا بردن خوانایی کد شما کمک کند. کد باید به صورتی نوشته شود که سایر برنامه نویسان در تیم به راحتی متوجه عملکرد آن شوند.
- زمانی که از منابع مدیریت نشده یا اصطلاحاً Unmanaged Resources استفاده می کنید، مانند فایل ها، منابع تحت شبکه و ...، حتماً عملیات Dispose کردن این منابع را مد نظر بگیرید تا برنامه شما به بهترین شکل از منابع استفاده کند. استفاده از عبارت using هنگام استفاده از منابع و همچنین پیاده سازی الگوری Dispose در برنامه ها به شدت توصیه می شود.
- مدیریت خطا باید به بهترین شکل در برنامه انجام شود، هر قسمتی که احتمال بروز خطا توسط کاربر وجود دارد باید توسط ساختار try..catch مدیریت شود. همچنین از کلیه خطاهای اتفاق افتاده حتماً log تهیه کنید تا بتوانید در اولین فرصت نسبت به بررسی و رفع آن ها اقدام کنید.
- متدهای نوشته شده باید کوتاه باشند، معمولاً برای یک متد نباید بیش از 30 خط کد نوشته شود. در غیر این صورت باید متد نوشته شده به متدهای کوچکتر شکسته شود.
پایان.
