تاریخ امروز:10 دی 1403
قراردادهای نامگذاری در جاوا

قراردادهای نامگذاری در جاوا

خب در این پست می‌خوام برخی قراردادهای نامگذاری در جاوا را بررسی کنم. در طول این مسیر  مواردی چون نام گذاری‌های Package، Final,Static و … را به شما می‌گویم. این‌ موارد فقط قرارداد هستند و نیازی به رعایت نیست. رعایت این موارد شما را برنامه‌نویس حرفه‌ای‌تری می‌کند و خوانایی کد شما را افزایش می‌دهد.

نام‌گذاری پکیج‌ها

  1. همواره از حروف کوچک استفاده کنید.
  2. نام پکیج هیچ‌گاه تکراری نیست.
  3. از hostname خود به عنوان یک عنوان اولیه در پکیج‌هاتون استفاده کنید.
  4. اوراکل یک‌سری قرارداد در این لینک جهت اسم‌گذاری پکیج‌ها قرار داده است.
  5. کاراکترهای غیرطبیعی را (Invalid Charachters) را با خط تیره جایگزین کنید.
  6. تلاش کنید از اسامی معنا دار و مرتبت با کاری که اون پکیج‌ می‌خواهد بکند استفاده کنید.
  7. hostname شما در صورتی که با عدد شروع شده بود با _ جایگزینش کنید. مثال‌های زیر را ببینید:
package Switch.supplier.com; => com.supplier._com;
package 1world.com; => com._1world.com;

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

  1. از روش کوهان شتر!!‌ استفاده کنید (به طور مثال به جای soroushtayyebi بنویسید SoroushTayyebi)
  2. نام کلاس باید اسم باشد ( از فعل و … استفاده نکنید)
  3. با حرف بزرگ شروع کنید.
  4. هر اسم در نام کلاس باید با حرف بزرگ شروع شود. (LinkedList)

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

  1. روش کوهان شتر استفاده کنید. (مانند کلاس‌ها)
  2. نام Interface باید حتما بیانگر کارایی آن باشد(مفهوم داشته باشد و آدم بفهمه که این Interface چه کاری قراره انجام بده)

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

  1. از روش mixedCase استفاده میشه در نامگذاری (مثلا soroushTayyebi)
  2. معمولا از فعل‌ها در نام‌گذاری آن‌ها استفاده میشه. (getName)

نام‌گذاری ثوابت (Constants)

  1. فقط از حروف بزرگ در آن‌ها استفاده شود.
  2. کلمات با آندرلاین (Underline) جدا شوند. (MAX_SIZE)

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

  1. از روش mixedCase استفاده میشه در نامگذاری (مثلا soroushTayyebi)
  2. با حروف کوچک شروع کنید.
  3. کلمات معنی دار انتخاب کنید.
  4. از Underline استفاده نکنید.

نام‌گذاری Type Parameters

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

  1. E‌: مخفف Elements
  2. T: مخفف Type
  3. K: مخفف Key
  4. V: مخفف Value

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

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *