Skip to main content

قواعد نام‌گذاری

نام‌گذاری باید قابل پیش‌بینی، domain محور و هماهنگ با stack همان پروژه باشد.

Backend / Domain​

  • classها با PascalCase نوشته می‌شوند
  • methodها و propertyها با camelCase نوشته می‌شوند
  • enumها singular هستند
  • interfaceها نام contract را نشان می‌دهند، نه صرفاً پیشوند یا پسوند تزئینی
  • booleanها باید با is، has، can یا should شروع شوند
final class UserActivationService
{
    public function canActivate(User $user): bool
    {
        return ! $user->isActive();
    }
}

Markup / UI Structure​

  • id و class با kebab-case نوشته می‌شوند
  • نام component باید هدف را نشان دهد
  • نام template یا view باید با feature هماهنگ باشد
<div id="user-profile-form" class="user-profile-form"></div>

JavaScript​

  • variable و function با camelCase نوشته می‌شوند
  • constantهای ثابت واقعی با UPPER_SNAKE_CASE نوشته می‌شوند
  • نام event handler باید action را توضیح دهد

Route / Endpoint Names​

نام route یا endpoint باید resource-oriented و قابل پیش‌بینی باشد.

admin.users.index
admin.users.store
admin.users.update

موارد ممنوع​

  • نام‌های مبهم مثل data، item و handle بدون context
  • abbreviationهای ناشناخته
  • مخلوط کردن زبان فارسی و انگلیسی در identifier
  • نام‌گذاری بر اساس implementation موقت