حسین منصوری
حسین منصوری
خواندن ۴ دقیقه·۵ سال پیش

قواعد نام گذاری در جاوا اسکریپت

رعایت استانداردهای نام‌گذاری هر زبان برنامه‌نویسی یکی از اولین معیارهای برنامه‌نویس حرفه‌ای بودنه. چه وقتی تیمی کار می‌کنیم، چه حتی وقتی که تنها کار می‌کنیم، رعایت استانداردها کمک میکنه که کدهامون قابل فهم‌تر باشه و بتونیم در آینده راحت‌تر اونها رو پشتیبانی کنیم.

توصیه‌هایی برای بهتر کد زدن
توصیه‌هایی برای بهتر کد زدن


اگر از مشتریهای توییتهای دونالد ترامپ باشید میدونید که استفاده از Caps lock به موقع چقدر اهمیت داره? پیروی از نام‌گذاری استاندارد همون قدر برای یک برنامه‌نویس اهمیت داره ?

پیش درآمد

چهار مدل مشهور برای نام‌گذاری اشیا در زبان‌های برنامه‌نویسی وجود داره. که به فارسی سخت به اونها نام‌گذاری پاسکالی، نام‌گذاری شتری، نام‌گذاری ماری و نام‌گذاری کبابی میگن ? هر چند نام‌های انگلیسی اونها مشهورتر هستند. در نام‌گذاری متغیرها ما نمیتونیم از space استفاده کنیم و این موضوع فلسفه‌ی اصلی این نام‌گذاری‌ها را تشکیل میدن.

  • پاسکالی (PascalCase): حرف اول تمام کلمات در رشته با حروف بزرگ نوشته میشه. معمولا برای نام‌گذاری کلاس استفاده می‌کنیم.
  • شتری (camelCase) : کلمه‌ی اول رشته با حرف کوچک نوشته میشه و مابقی کلمات با حرف بزرگ شروع میشن. برای نام‌گذاری متغیرهای محلی استفاده میشه.
  • ماری (snake_case): تمام کلمات با حرف کوچک شروع میشن و بینشون under line قرار میگیره. معمولا برای نام‌گذاری ثابت‌ها ازش استفاده میشد.
  • کبابی (kebab-case): تمام کلمات با حرف کوچک شروع میشن و بینشون خط فاصله (-) قرار میگیره. برای نام‌گذاری فایل‌ها و آدرس‌دهی urlها معمولا استفاده میشه.


قواعد نام‌گذاری در جاوا اسکریپت: متغیر

زبان جاوا اسکریپت Case sensitive هست. یعنی بین نام متغیر با حروف کوچک با نام متغیر با حروف بزرگ تفاوت قائل میشه.

جاوا اسکریپت case sensitive است!
جاوا اسکریپت case sensitive است!

نامی که انتخاب میکنید باید بتونه خودش رو توصیف کنه. از علائم مختصر، بی‌معنی و کوتاه استفاده نکنید.

برای اسم متغیر خساست به خرج ندید!
برای اسم متغیر خساست به خرج ندید!

اکثرا در هنگام تعریف متغیر در جاوا اسکریپت از نامگذاری Camel case استفاده میکنیم. در اکثر زبانهای برنامه‌نویسی قاعده نام‌گذاری متغیر به همین شکله.

نام‌گذاری متغیرها به صورت Camel case
نام‌گذاری متغیرها به صورت Camel case

قواعد نام‌گذاری در جاوا اسکریپت: Boolean

برای نام‌گذاری متغیرهای boolean استفاده از prefix های are، is و has توصیه میشه. این موضوع سبب میشه که این متغیرها از مابقی متغیرها متمایز باشند و نام اونها بامعنی‌تر بشه.

نام‌گذاری boolean ها
نام‌گذاری boolean ها


قواعد نام‌گذاری در جاوا اسکریپت: تابع

توصیه میشه که نام تابع رو با فعل شروع کنیم. همچنین تحت هیچ شرطی از نام‌هایی مثل get2 یا getNameNew استفاده نکنید. اینجا هم خساست به خرج ندید، هر چقدر که نام تابع بتونه توصیف بهتری از کار اون تابع باشه، بهتر هست.

نام‌گذاری توابع
نام‌گذاری توابع


قواعد نام‌گذاری در جاوا اسکریپت: کلاس

در جاوا اسکریپت مثل اکثر زبانها کلاس‌ها به صورت Pascal Case نام‌گذاری میشن. این موضوع به افزایش contrast بین کلاس و دیگر متغیرها کمک میکنه.

نام‌گذاری کلاس
نام‌گذاری کلاس


قواعد نام‌گذاری در جاوا اسکریپت: Component

ما component ها رو اغلب سمت frameworkهای front end مثل ری اکت یا vue.js میبینم. مثل کلاس‌ها اینجا هم از نام‌گذاری Pascal Case استفاده می‌کنیم.

نام‌گذاری Component
نام‌گذاری Component

به دلیل استفاده از نام‌گذاری Pascal Case تمایز خوبی هم بین Component ما با المان‌های پیش فرض html به وجود میاد.

تمایز با المان‌های html
تمایز با المان‌های html


قواعد نام‌گذاری در جاوا اسکریپت: متد

اینجا هم به مانند نام‌گذاری تابع‌ها، نام متد رو با فعل شروع میکنیم و از استاندارد camel Case استفاده میکنیم.

نام‌گذاری متد
نام‌گذاری متد


قواعد نام‌گذاری در جاوا اسکریپت: متغیرهای Private

هر چند در این مورد قانون کلی وجود نداره اما بهتر هست که متغیر و متدهای private یک کلاس رو که قرار نیست در مابقی پروژه استفاده بشه، با استفاده underscore (_) شروع کنید. در زبان‌های برنامه‌نویسی دیگه هم این قانون برقرار است.

نام‌گذاری متغیرهای Private
نام‌گذاری متغیرهای Private


قواعد نام‌گذاری در جاوا اسکریپت: ثابت‌ها

ثابت‌ها متغیرهایی هستند که قرار نیست مقدار اونها توی طول برنامه تغییر کنه. بهتر هست که ثابت‌ها رو با حروف بزرگ بنویسید.

نام‌گذاری ثابت‌ها
نام‌گذاری ثابت‌ها

اگر ثابت چند کلمه‌ای داشتید، میتونید کلمات ثابت رو با زیر خط جدا کنید.

ثابت چند کلمه‌ای
ثابت چند کلمه‌ای


قواعد نام‌گذاری در جاوا اسکریپت: متغیرهای Global

متغیرهای Global متغیرهایی هستند که در کل پروژه از مقدارشون استفاده میکنیم. خوبه که موارد زیر رو هنگام تعریف این متغیرها در نظر بگیرید:

  • متغیرهای Global رو در ابتدا فایل بنویسید.
  • اگر مقدار متغیرتون در طول برنامه تغییر میکنه از نام‌گذاری camel Case استفاده کنید.
  • اگر مقدار متغیرتون در طول برنامه ثابته از نام‌گذاری Pascal Case استفاده کنید.


قواعد نام‌گذاری در جاوا اسکریپت: استفاده از Underscore

از وقتی که نام‌گذاری‌های Pascal Case و camel Case محبوب‌تر شدند، استفاده از Underscore برای معرفی متغیر به شدت محدود شده. این روزها فقط برای معرفی متغیرهای private از Underscore استفاده میکنیم و پیشنهاد میشه که کمتر از این نوع نام‌گذاری استفاده کنیم.


قواعد نام‌گذاری در جاوا اسکریپت: استفاده از Dash

استفاده از Dash هم برای نام‌گذاری متغیرها چندان منطقی این روزها به نظر نمیرسه و موجب ناخوانی کدهای ما میشه.

نام‌گذاری نادرست با استفاده از dash
نام‌گذاری نادرست با استفاده از dash


قواعد نام‌گذاری در جاوا اسکریپت: فایل

در سمت Front End معمولا فایلها رو به صورت Pascal Case نام‌گذاری می‌کنند.

نام‌گذاری فایل در سمت Front End
نام‌گذاری فایل در سمت Front End

برخلاف Front End در سمت Back End معمولا از روش kebab-case استفاده میشه.

نام‌گذاری فایل در سمت Back End
نام‌گذاری فایل در سمت Back End

ممکنه که سیستم عاملی بین کاراکترهای بزرگ و کوچک توی نام‌فایل تفاوتی قائل نشه. به همین دلیل به نظر میرسه که استفاده از نام گذاری kebab-case منطقی‌تر باشه.

امیدوارم این نوشته براتون مفید واقع بشه، اگر چیزی رو از قلم انداختم یا جایی اشتباه کردم حتما بهم بگید و خوشحالم کنید.

منابع: + و +.

java scriptnaming conventions
طراح، تحلیل‌گر، برنامه‌نویس بک اند و مدیر دیتابیس. علاقمند به فیلم و سریال، اهل پادکست و سفر، طرفدار زندگی و عاشق گفتگو :)
شاید از این پست‌ها خوشتان بیاید