قواعد نام گذاری
از جمله مواردی که در برنامه نویسی از اهمیت زیادی برخوردار میباشد زیبا نویسی و یا تمیز بودن کد ها میباشد. یکی از مواردی که باعث میشود کدهای زیبا و تمیز داشته باشیم رعایت اصول نام گذاری است. در برنامه نویسی از روش های مختلفی برای نام گذاری اسامی کلاس ها، متغیر ها و ... میتوان استفاده کرد. قواعد نام گذاری از اصول استاندار زیر پیروی میکنند :
camelCase
روش camelCase که به آن نگارش شتری نیز گفته میشود. در این روش حرف اولین کلمه با حروف کوچک و سایر کلمات با حرف بزرگ شروع میشود و سایر حروف انها کوچک میباشد; در این روش بین کلمات هیچ جدا کننده ای نیست.
مثال :
camelCase, userId, lastOnline
PascalCase
در روش PascalCase تمامی کلمات با حروف بزرگ شروع میشوند و سایر حروف ان کوچک است. دراین روش بین کلمات هیچ جدا کننده ای نیست.
مثال :
PascalCase, NewObject, UserTypes
snake_case
روش snake_case که به آن نگارش ماری نیز گفته میشود. در این روش تمامی حروف کوچک میباشد و کلمات با underline ( _ ) از هم جدا میشوند.
مثال :
snake_case, first_name, contact_us
SCREAMING_SNAKE_CASE
نوعی از نگارش ماری است که تمامی حروف آن با حرف بزرگ نوشته میشوند.
مثال :
SCREAMING_SNAKE_CASE, PI_NUMBER, WAIT_FOR_ACCEPT
kebab-case
روش kebab-case که به آن نگارش کبابی نیز گفته میشود. در این روش تمامی حروف کوچک میباشد و کلمات با dash ( - ) از هم جدا میشوند.
توجه : namespace از این روش نام گذاری پشتیبانی نمیکند به همین دلیل نمیتوانید از این روش برای نام گذاری پکیج‌ها استفاده کنید . بطور کلی طبق قرار‌داد‌هایی که برای نام گذاری در جالنو تعریف شده است از این روش در هیچ قسمتی استفاده نمی‌شود.
مثال :
kebab-case, read-only
استفاده از هر یک از روش های فوق در برنامه نویسی عموما دلخواه میباشد اما برای منسجم شدن کدها پیشنهاد میشود از قوانین مشخصی، برای نام گذاری هر یک از پارامتر ها استفاده کنید.
میتوانید برای منسجم شدن کدها از قواعد زیر پیروی نمایید.
| پارامتر | روش نام گذاری | مثال |
|---|---|---|
| کلاس | PascalCase | BankAccount |
| ایترفیس | PascalCase و با I شروع میشود | ITemplate |
| کلاس های مجرد | PascalCase و با Abstract به پایان میرسد. | SessionAbstract |
| متد | camelCase | doLogin |
| پکیج | snake_case | my_package |
| اسم جداول و ستون های دیتابیس | snake_case | userpanel_users |
| ثابت | SCREAMING_SNAKE_CASE | PI_NUMBER |
چند نکته مهم
- اسم کنترلر ها عموما در حالت جمع به کار برده شود.
- اسم مدل ها عموما در حالت مفرد به کار برده شود.
- اسم جداول دیتابیس عموما در حالت جمع به کار برده شود.
- در هر فایل حداکثر یک کلاس/اینترفیس/Trait تعریف شود و نام فایل دقیقا با اسم آن یکسان باشد.