روش نامگذاری Smurf ایی!
نویسنده: وحید نصیری
تاریخ: ۱۳۹۱/۰۶/۱۱ ۱۱:۱
آدرس: www.dntips.ir
| مطالب | ۳۶۹۴ |
| نویسندگان | ۲۷۶ |
| گروههای مطالب | ۱۰۲۴ |
| نقشههای راه | ۱۱۹ |
| دورهها | ۱۴ |
| اشتراکها | ۱۷۹۱۴ |
اگر به یک سری از کتابخانهها دقت کنید، تمام کلاسهای آنها دارای یک پیشوند تکراری هستند؛ مثلا SmurfXMLDataRow، SmurfXMLElement و الی آخر در مورد تمام کلاسهای موجود در پروژه. به این رویه «Smurf Naming Convention» گفته میشود!
در این نوع کتابخانهها زمانیکه کاربری بر روی دکمهای کلیک میکند، SmurfAccountView اطلاعات SmurfAccountDTO را به SmurfAccountController منتقل میکند. در ادامه از خاصیت SmurfID دریافتی، مقدار SmurfOrderHistory دریافت شده و به SmurfHistoryReportingView جهت نمایش ارسال خواهد شد. اگر استثنای SmurfErrorEvent رخ دهد، توسط SmurfErrorLogger در فایلی به نام log/smurf/smurflog.log ثبت خواهد شد.
کلمه Smurf هم از شخصیتی کارتونی به همین نام اخذ شده است که در زبان مخصوص آنها اکثر افعال و نامها از کلمه Smurf مشتق میشود! برای مثال در مورد ماهیگیری کردن در یک رودخانه عنوان میکنند «We're going smurfing on the River Smurf today».
خوب، چکار باید کرد؟ روش صحیح معرفی نام یک شرکت در حین طراحی و نامگذاری کلاسهای یک کتابخانه چیست؟
در مطلب بسیار جامع و عالی «اصول و قراردادهای نامگذاری در داتنت» عنوان شده است که اساس نامگذاری فضاهای نام باید از قاعده زیر پیروی کند:
مثلا مایکروسافت یکبار فضای نام Microsoft.Reporting.WebForms را تعریف کرده است و ... همین! دیگر به ابتدای هر کلاسی در این کتابخانه، پیشوند Microsoft یا MS و امثال آن اضافه نشده است تا بر روی اعصاب و روان استفاده کننده تاثیر منفی داشته باشد.
در این نوع کتابخانهها زمانیکه کاربری بر روی دکمهای کلیک میکند، SmurfAccountView اطلاعات SmurfAccountDTO را به SmurfAccountController منتقل میکند. در ادامه از خاصیت SmurfID دریافتی، مقدار SmurfOrderHistory دریافت شده و به SmurfHistoryReportingView جهت نمایش ارسال خواهد شد. اگر استثنای SmurfErrorEvent رخ دهد، توسط SmurfErrorLogger در فایلی به نام log/smurf/smurflog.log ثبت خواهد شد.
کلمه Smurf هم از شخصیتی کارتونی به همین نام اخذ شده است که در زبان مخصوص آنها اکثر افعال و نامها از کلمه Smurf مشتق میشود! برای مثال در مورد ماهیگیری کردن در یک رودخانه عنوان میکنند «We're going smurfing on the River Smurf today».
خوب، چکار باید کرد؟ روش صحیح معرفی نام یک شرکت در حین طراحی و نامگذاری کلاسهای یک کتابخانه چیست؟
در مطلب بسیار جامع و عالی «اصول و قراردادهای نامگذاری در داتنت» عنوان شده است که اساس نامگذاری فضاهای نام باید از قاعده زیر پیروی کند:
<Company>.<Technology|Produt|Project>[.<Feature>][.<SubNamespace>]
مطالب مشابه
-
اشتراکهادرک کلمه کلیدی `sealed` در C#: کاربردها و مزایااشتراکهاپیادهسازی قراردادهای نامگذاری Azure در مقیاس بزرگ با Terraform و Build5Nines/naming/azureپاسخ به پرسشهابهترین روش تولید متن پیغام کدام است؟پاسخ به پرسشهاآیا استفاده از FullName یک کلاس تضادی با Clean Code دارد؟مطالباصول و قراردادهای نامگذاری در داتنتمطالببازنویسی سادهتر پیش فرضهای EF Code first در نگارش 6 آنمطالبمفاهیم برنامه نویسی ـ مروری بر فیلدها، متدها و ساخت اشیاءمطالبهنر بکارگیری پیشوندهای بولی: چرا نباید متغیرهای خود را "Flag" نامگذاری کنیدنظرات مطالبارتقاء به ASP.NET Core 1.0 - قسمت 19 - بومی سازینظرات مطالبروش نامگذاری Smurf ایی!
نظرات
- رحمت اله رضایی در ۱۳۹۱/۰۶/۱۱ ۱۸:۳۸مشکل اینجاست که در پروژه ای، کلاسهایی هم اسم کلاسهای دات نت داشته باشیم. همیشه باید فضای نام را در ابتدای کلاسها نوشت.
مثلا فرض کنید کنترلهای TextBox و Button و ... را در یک پروژه وب فرم یا ویندوز فرم سفارشی کرده باشیم. در این حالت چکار باید بکنیم؟- وحید نصیری در ۱۳۹۱/۰۶/۱۱ ۱۹:۲۰- برنامه FxCop میتونه اسمبلیهای شما رو آنالیز کنه و دقیقا گزارش بده که چه مواردی هم نام کلاسهای پایه دات نت هستند و بهتر است تغییر نام پیدا کنند. بنابراین به این صورت میتونید خیلی سریع حجم بالایی از کدها رو بررسی و رفع اشکال کنید.
- به علاوه زمانیکه طراح شما هستید، محدودیتی در نامگذاری نهایی وجود ندارد. مثلا نام کلاس مشتق شده را NumericTextBox قرار دهید و مواردی مانند این که بیانگر عملکرد سفارشی و ویژه کلاس مشتق شده جدید هستند:
public class RequiredTextBox : TextBox