اصول و قراردادهای نام‌گذاری در دات‌نت

شروع موضوع توسط fns4565 ‏Jul 5, 2017 در انجمن ASP / ASP.Net

  1. fns4565

    fns4565 عضو تایید شده کاربر انجمن

    نامگذاری (Naming) اشیا یک برنامه شاید در نگاه اول دارای اهمیت بالایی نباشه، اما تجربه نشون داده که در پروژه‌های بزرگ که با کمک چندین مجموعه به انجام میرسه نامگذاری صحیح و اصولی که از یکسری قواعد کلی و مناسب پیروی میکنه میتونه به پیشبرد اهداف و مدیریت راحتتر برنامه کمک بسیاری بکنه.
    بیشتر موارد اشاره شده در این مطلب از کتاب جامع و مفید Framework Design Guidelines اقتباس شده که خوندن این کتاب مفید رو به خوانندگان توصیه میکنم.
    برای کمک به نوشتن اصولی و راحتتر سورسهای برنامه‌ها در ویژوال استودیو نرم افزارهای متعددی وجود داره که با توجه به تجربه شخصی خودم نرم افزار Resharper محصول شرکت Jetbrains یکی از بهترین هاست که در مورد خاص مورد بحث در این مطلب نیز بسیار خوب عمل میکنه.
    برخی از موارد موجود در مطلب جاری نیز از قراردادهای پیشفرض موجود در نرم افزار Resharper نسخه 6.0 برگرفته شده است و قسمتی نیز از تجربه شخصی خودم و سایر دوستان و همکاران بوده است.
    اصل این مطلب حدود یکسال پیش تهیه شده و اگر نقایصی وجود داره لطفا اشاره کنین.

    اصول و قراردادهای نام‌گذاری در دات‌نت
    انواع نام‌گذاری

    نام‌گذاری اشیا در حالت کلی را می‌توان به سه روش زیر انجام داد:
    1. Pascal Casing: در این روش حرف اول هر کلمه در نام شی به صورت بزرگ نوشته می‌شود.
    FirstName

    2. camel Casing: حرف اول در اولین کلمه نام هر شی به صورت کوچک و حرف اول بقیه کلمات به صورت بزرگ نوشته می‌شود.
    firstName

    3. Hungarian: در این روش برای هر نوع شی موجود یک پیشوند درنظر گرفته می‌شود تا از روی نام شی بتوان به نوع آن پی برد. در ادامه و پس از این پیشوندها سایر کلمات بر اساس روش Pascal Casing نوشته می‌شوند.
    strFirstName
    lblFirstName

    نکته: استفاده از این روش به جز در نام‌گذاری کنترل‌های UI منسوخ شده است.

    قراردادهای کلی

    1. نباید نام اشیا تنها در بزرگ یا کوچک بودن حروف با هم فرق داشته باشند. به عنوان مثال نباید دو کلاس با نام‌های MyClass و myClass داشته باشیم. هرچند برخی از زبان‌ها case-sensitive هستند اما برخی دیگر نیز چنین قابلیتی ندارند (مثل VB.NET). بنابراین اگر بخواهیم کلاس‌های تولیدی ما در تمام محیط‌ها و زبان‌های برنامه نویسی قابل اجرا باشند باید از این قرارداد پیروی کنیم.
    2. تا آنجا که امکان دارد باید از به‌کار بردن مخفف کلمات در نام‌گذاری اشیا دوری کنیم. مثلا به جای استفاده از GetChr باید از GetCharacter استفاده کرد.
    البته در برخی موارد که مخفف واژه موردنظر کاربرد گسترده ای دارد می‌توان از عبارت مخفف نیز استفاده کرد. مثل UI به جای UserInterface و یا IO به جای InputOutput.

    آ. اصول نام‌گذاری فضای نام (namespace)
    1. اساس نام‌گذاری فضای نام باید از قاعده زیر پیروی کند:
    <Company>.<Technology|Produt|Project>[.<Feature>][.<SubNamespace>]

    ( < > : اجباری [ ] : اختیاری )
    2. برای نام‌گذاری فضای نام باید از روش Pascal Casing استفاده شود.
    3. در هنگام تعریف فضاهای نام به وابستگی آنها توجه داشته باشید. به عنوان مثال اشیای درون یک فضای نام پدر نباید به اشیای درون فضای نام یکی از فرزندانش وابسته باشد. مثلا در فضای نام System نباید اشیایی وجود داشته باشند که به اشیای درون فضای نام System.UI وابسته باشند.
    4. سعی کنید از نام‌ها به صورت جمع برای عناوین فضای نام استفاده کنید. مثلا به جای استفاده از Kara.CSS.HQ.Manager.Entity از Kara.CSS.HQ.Manager.Entities استفاده کنید. البته برای مورادی که از عناوین مخفف و یا برندهای خاص استفاده کرده‌اید از این قرارداد پیروی نکنید. مثلا نباید از عنوانی شبیه به Kara.CSS.Manager.IOs استفاده کنید.
    5. از عنوانی پایدار و مستقل از نسخه محصول برای بخش دوم عنوان فضای نام استفاده کنید. بدین معنی که این عناوین با گذر زمان و تغییر و تحولات در محتوای محصول و یا تولیدکننده نباید تغییر کنند. مثال:
    Microsoft.Reporting.WebForms
    Kara.Support.Manager.Enums
    Kara.CSS.HQ.WebUI.Configuration

    6. از عناوین یکسان برای فضای نام و اشیای درون آن استفاده نکنید. مثلا نباید کلاسی با عنوان Manager در فضای نام Kara.CSS.Manager وجود داشته باشد.
    7. از عناوین یکسان برای اشیای درون فضاهای نام یک برنامه استفاده نکنید. مثلا نباید دو کلاس با نام Package در فضاهای نام Kara.CSS.Manger و Kara.CSS.Manger.Entities داشته باشید.

    ب. اصول نام‌گذاری کلاس‌ها و Structها

    1. عنوان کلاس باید اسم یا موصوف باشد.
    2. در نام‌گذاری کلاس‌ها باید از روش Pascal Casing استفاده شود.
    3. نباید از عناوین مخففی که رایج نیستند استفاده کرد.
    4. از پیشوندهای زائد مثل C یا Cls نباید استفاده شود.
    5. نباید از کاراکترهایی به غیر از حروف (و یا در برخی موارد خیلی خاص، شماره نسخه) در نام‌گذاری کلاس‌ها استفاده شود.
    مثال:
    درست:
    PackageManager , PacakgeConfigGenerator
    Circle , Utility , Package

    نادرست:
    CreateConfig , classdata
    CManager , ClsPackage , Config_Creator , Config1389

    6. در نام‌گذاری اشیای Generic از استفاده از عناوینی چون Element, Node, Log و یا Message پرهیز کنید. این کار موجب به‌وجودآمدن کانفلیکت در عناوین اشیا می‌شود. در این موارد بهتر است از عناوینی چون FormElement, XmlNode, EventLog و SoapMessage استفاده شود. درواقع بهتر است نام اشیای جنریک، برای موارد موردنیاز، کاملا اختصاصی و درعین حال مشخص‌کننده محتوا و کاربرد باشند.
    7. از عناوینی مشابه عناوین کتابخانه‌های پایه دات‌نت برای اشیای خود استفاده نکنید. مثلا نباید کلاسی با عنوان Console, Parameter, Action و یا Data را توسعه دهید. هم‌چنین از کابرد عناوینی مشابه اشیای موجود در فضاهای نام غیرپایه دات‌نت و یا غیردات‌نتی اما مورداستفاده در پروژه خود که محتوا و کاربردی مختص همان فضای نام دارند پرهیز کنید. مثلا نباید کلاسی با عنوان Page در صورت استفاده از فضای نام System.Web.UI تولید کنید.
    8. سعی کنید در مواردی که مناسب به‌نظر می‌رسد از عنوان کلاس پایه در انتهای نام کلاس‌های مشتق‌شده استفاده کنید. مثل FileStream که از کلاس Stream مشتق شده است. البته این قاعده در تمام موارد نتیجه مطلوب ندارد. مثلا کلاس Button که از کلاس Control مشتق شده است. بنابراین در به‌کاربردن این مورد بهتر است تمام جوانب و قواعد را درنظر بگیرید.

    پ. اصول نام‌گذاری مجموعه‌ها (Collections)

    یک مجموعه در واقع یک نوع کلاس خاص است که حاوی مجموعه‌ای از داده‌هاست و از همان قوانین کلاس‌ها برای نام‌گذاری آن‌ها استفاده می‌شود.
    1. بهتر است در انتهای عنوان مجموعه از کلمه Collection استفاده شود. مثال:
    CenterCollection , PackageCollection

    2. البته درصورتی‌که کلاس مورد نظر ما رابط IDictionary را پیاده‌سازی کرده باشد بهتر است از پسوند Dictionary استفاده شود.

    ت. اصول نام‌گذاری Delegateها

    1. عنوان یک delegate باید اسم یا موصوف باشد.
    2. در نام‌گذاری delegateها باید از روش Pascal Casing استفاده شود.
    3. نباید از عناوین مخففی که رایج نیستند استفاده کرد.
    4. از پیشوندهای زائد مثل D یا del نباید استفاده شود.
    5. نباید از کاراکترهایی به غیر از حروف در نام‌گذاری delegateها استفاده شود.
    6. نباید در انتهای نام یک delegate از عبارت Delegate استفاده شود.
    7. بهتر است که درصورت امکان در انتهای نام یک delegate که برای Event Handler استفاده نمی‌شود از عبارت Callback استفاده شود. البته تنها درصورتی‌که معنی و مفهوم مناسب را داشته باشد.
    مثال:
    نحوه تعریف یک delegate
    public delegate void Logger (string log);
    public delegate void LoggingCallback (object sender, string reason);


    ث. اصول نام‌گذاری رویدادها (Events)

    1. عنوان یک رویداد باید فعل یا مصدر باشد.
    2. در نام‌گذاری کلاس‌ها باید از روش Pascal Casing استفاده شود.
    3. نباید از عناوین مخففی که رایج نیستند استفاده کرد.
    4. از پیشوندهای زائد نباید استفاده شود.
    5. نباید از کاراکترهایی به غیر از حروف در نام‌گذاری رویدادها استفاده شود.
    6. بهتر است از پسوند EventHandler در عنوان هندلر رویداد استفاده شود.
    7. از به کاربردن عباراتی چون AfterXXX و یا BeforeXXX برای نمایش رویدادهای قبل و یا بعد از رخداد خاصی خودداری شود. به جای آن باید از اسم مصدر (شکل ingدار فعل) برای نام‌گذاری رویداد قبل از رخداد و هم‌چنین شکل گذشته فعل برای نام‌گذاری رویداد بعد از رخداد خاص استفاده کرد.
    مثلا اگر کلاسی دارای رویداد Open باشد باید از عنوان Openning برای رویداد قبل از Open و از عنوان Opened برای رویداد بعد از Open استفاده کرد.
    8. نباید از پیشوند On برای نام‌گذاری رویداد استفاده شود.
    9. همیشه پارامتر e و sender را برای آرگومانهای رویداد پیاده سازی کنید. sender که از نوع object است نمایش دهنده شیی است که رویداد مربوطه را به وجود آورده است و e درواقع آرگومانهای رویداد مربوطه است.
    10. عنوان کلاس‌آرگومان‌های رویداد باید دارای پسوند EventArgs باشد.
    مثال:
    عنوان کلاس‌آرگومان:
    AddEventArgs , EditEventArgs , DeleteEventArgs

    عنوان رویداد:
    Adding , Add , Added

    تعریف یک EventHandler:
    public delegate void <EventName>EventHandler (object sender, <EventName>EventArgs e);

    نکته: نیاز به تولید یک EventHandler مختص توسعه یک برنامه به‌ندرت ایجاد می‌شود. در اکثر موارد می‌توان با استفاده از کلاس جنریک <EventHandler<TEventArgs تمام احتیاجات خود را برطرف کرد.
    تعریف یک رویداد:
    public event EventHandler <AddEventArgs> Adding;


    ج. اصول نام‌گذاری Attributeها

    1. عنوان یک attribute باید اسم یا موصوف باشد.
    2. در نام‌گذاری attributeها باید از روش Pascal Casing استفاده شود.
    3. نباید از عناوین مخففی که رایج نیستند استفاده کرد.
    4. از پیشوندهای زائد مثل A یا atr نباید استفاده شود.
    5. نباید از کاراکترهایی به غیر از حروف در نام‌گذاری attributeها استفاده شود.
    6. بهتر است در انتهای نام یک attribute از عبارت Attribute استفاده شود.
    مثال:
    DisplayNameAttribute , MessageTypeAttribute


    چ. اصول نام‌گذاری Interfaceها

    1. در ابتدای عنوان interface باید از حرف I استفاده شود.
    2. نام باید اسم، موصوف یا صفتی باشد که interface را توصیف می‌کند.
    به عنوان مثال:
    IComponent (اسم)
    IConnectionProvider (موصوف)
    ICloneable (صفت)

    3. از روش Pascal Casing استفاده شود.
    4. خودداری از بکاربردن عبارات مخفف غیررایج.
    5. باید تنها از کاراکترهای حرفی در نام interface استفاده شود.
    ح. اصول نام‌گذاری Enumerationها
    1. استفاده از روش Pascal Casing
    2. خودداری از کاربرد عبارات مخفف غیررایج
    3. تنها از کاراکترهای حرفی در نام Enumretionها استفاده شود.
    4. نباید از پسوند یا پیشوند Enum یا Flag استفاده شود.
    5. اعضای یک Enum نیز باید با روش Pascal Casing نام‌گذاری شوند.
     
    msm از این پست تشکر کرده است.

به اشتراک بگذارید

س