راهنمای اسم گذاری مقادیر در محیط دات نت (ویژوال استودیو)

مفاهیم برنامه نویسی

تعداد بازدید : 3110

تاریخ و ساعت انتشار : یک شنبه 15 مرداد 1396 04:34

از آنجایی که برنامه نویسان زیادی ممکن است همزمان برروی یک پروژه کارکنند، رسیدن به یک الگوی مشترک، برای جلوگیری از بهم ریختگی و ناهماهنگی در کارها، یک امر ضروری به حساب میاید.
لذا نامهایی که برای مقادیر و متغیرهای مختلف انتخاب میشود باید خوانا، قابل فهم و نشان دهنده کارایی هر بخش باشد.

استفاده از حروف کوچک و بزرگ
برای متمایزکردن کلمه ها از یکدیگر اولین حرف را به صورت Capital یا با حرف بزرگ مینویسیم.
نکته : هرگز از علائمی مثل "_" یا "–" (underscores) در کلمات استفاده نکنید.
به طورکلی دو روش برای استفاده از حروف بزرگ در کلمات وجود دارد:
• PascalCasing
• camelCasing

PascalCasing

از این حالت میتوان برای تمامی identifierها استفاده کرد به جز اسم پارامترها
در حالت PascalCasing، حرف اول هر کلمه را بزرگ مینویسیم :
مثلاً : PropertyDescriptor یا HtmlTag
حالت خاص : در کلمات مخفف دوحرفی، هر دو حرف را بزرگ مینویسیم ، مثلا:
IOStream

CamelCasing

از این حالت فقط برای نامگذاری پارامترها استفاده میکنیم
درحالت CamelCasing، حرف اول همه کلمات بزرگ نوشته میشود جز کلمه اول
مثلاً : htmlTag یا propertyDescriptor
در کلمات مخفف دوحرفی، هردوحرف را کوچک مینویسیم : ioStream

از PascalCasing استفاده میکنیم در :
•   پارامترهای عمومی (Public Members)
•   نوع ها (Types)
•   NameSpace هایی که از چندین کلمه تشکیل شده است

از camelCasing استفاده میکنیم در :
تمام پارامترها

الگوی نامگذاری کلمات

همیشه سعی کنید کلمات خوانا و قابل فهم را برای مقادیر انتخاب کنید (یعنی طبق الگوی زبان انگلیسی، اگر کلمه صفت است درجای مناسب و قبل از موصوف ، یا اگر نوع متغیر Boolean است از کلمات پرسشی برای اولین کلمه استفاده کنیم)
مثلاً : HorizontalAlignment به جای AlignmentHorizontal
CanScrollHorizontally بهتر از ScrollableX است.

هرگز از اینها استفاده نکنید:
•   underscore ها (_)
•   Hyphen ها (علائم اتصال مثل -)
•   و کاراکترهایی غیر از حروف و عدد (مثل * % $)

نامگذاری به شیوه کلمات مخفف

هرگز از کلمات مخفف یا کوتاه شده، به جای کلماتی که باید کامل باشند استفاده نکنید.
مثلا:
استفاده از GetWin به جای GetWindow

به جای استفاده از کلمات کلیدی زبان برنامه نویسی، از کلمات مشخص و قابل فهم استفاده کنید:
مثلا :
GetLength به جای GetInt (Int کلمه کلیدی است)

نامگذاری Assembly ها و DLL ها :
DLL ها و Assemblyها باید تا جای ممکن شامل کلماتی باشد که کاربرد آن را نشان میدهد:
مثلاً System.Data

نامگذاری Class , Interface , Structs

•   Class ها و Struct ها را به شیوه camelCasing نامگذاری کنید.
•   برای interface ها از صفت استفاده کنید ، و درصورت لزوم، از کلمات کاربردی استفاده کنید.
•   همچنین ، قبل هر کلمه حرف I را به نشانه Interface قرار دهید :
مثلاً : IDisposable (Disposable به معنای قابل بسته شدن ، یک صفت است و I هم قبل از آن آمده)

نامگذاری Enum ها

از کلمات مفرد و خاص برای Enum ها استفاده کنید مگر اینکه آن Enum شامل مقادیر نوع bit باشد، دراینصورت ، از نام های چندگانه استفاده کنید.
•   هرگز خود کلمه Enum را در انتهای آن به کار نبرید
•   هرگز از کلمه Flag یا Flags در انتهای آن استفاده نکنید
•   از پیشوند نیز استفاده نکنید مثلاً rtf به معنای RichTextEnums

نامگذاری متدها :
چون متد قرار است کاری در برنامه انجام دهد پس نام آن نیز باید یک فعل یا شامل افعال باشد
مثلاً :
Public int CompareTo () به معنای مقایسه کن با ...
Public string [] Split () به معنای جداکن

نامگذاری Property ها

برخلاف سایر مقادیر، نام یک Property باید یک اسم یا صفت باشد.
چون property قرار است به یک داده اشاره کند، نام آن باید نشان دهنده آن داده موردنظر باشد.

• همیشه از PascalCasing برای نامگذاری استفاده کنید
• Property های نوع Boolean را به صورت کلمه پرسشی مثبت نامگذاری کنید:
مثلا: CanSeek (آیا میتواند ببیند) به جای CantSeek (آیا نمیتواند ببیند)

نامگذاری Event ها

یک Event همیشه قرار است به یک عمل اشاره کند، عملی که به زودی قرار است اتفاق بیفتد (مثل کلیک کردن برروی یک دکمه) یا عملی که اتفاق افتاده (دکمه ای که رویش کلیک شده).
Event ها را به صورت فعل نامگذاری میکنند و زمان آن فعل باید به گونه ای باشد که نشان دهد آن عمل دقیقاً در چه زمانی رخ داده ، مثلاً:
اگر روی یک دکمه کلیک شده و تمام شده ، نامش باید Clicked (کلیک شده است) باشد نه Clicking (درحال کلیک کردن)

پس همیشه از زمان حال و گذشته ، به جای کلماتی مثل Before یا After استفاده کنید.
- EventHandler ها را با پسوند "EventHandler" نامگذاری کنید