💎 قرارداد نام گذاری در جاوا (Naming Conventions)

🔆 یکسری قرارداد وجود دارد که میان برنامه نویسان جاوا پذیرفته شده است. مثلا برای نامگذاری کلاس ها، متد ها، متغیر ها و... قرارداد هایی وجود دارد که معمولا بهتر است پذیرفته شود. زیرا به خوانایی کد کمک میکند. البته هیچ الزامی برای پیروی نیست.

🔅 قرارداد نام گذاری پکیج ها (Packages):
- اسم پکیج ها باید با حروف کوچک نوشته شود (lowercase). برای مثال java, lang... اگر اسم شامل چند کلمه میباشد، میبایست کلمات را با دات (.) جدا کرد. برای مثال
java.util
java.lang
💡 اسامی خاص و منحصر بفرد برای مثال دامنه اینترنتی یک سایت یا یک شرکت بعنوان پکیج معمولا به صورت زیر نوشته میشود:

com.ithooloo
com.company
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese

🔅 قرارداد نام گذاری کلاس ها (Class):
- اسم کلاس باید با حرف بزرگ شروع شود
- اسم کلاس باید یک متشکل از اسم (noun) باشد و در حالت ترکیبی با کلمات دیگر حرف اول هر کلمه بصورت کاپیتال باشد. اسم کلاس باید ساده و ویژگی های کلاس را بخوبی توصیف کند. برای مثال:
class Raster
class ImageSprite


class Employee
class String
class StringBuffer 

🔅 قرارداد نام گذاری اینترفیس ها (Interfaces):
- اسم اینترفیس ها مانند اسامی کلاس ها باید با حرف بزرگ شروع شود.
interface RasterDelegate
interface Storing
💡 البته پیشنهاد میشود اسامی اینترفیس ها (و نه لزوما) به گونه ای تعریف شود که انگار توصیف کننده یک عمل برای کلاس است. برای مثال:

interface Runnable
interface Comparable 
interface Enumerable

🔅 قرارداد نام گذاری متد ها (Methods):
- اسامی متد ها باید با حرف کوچک شروع شود. در صورت ترکیب چند کلمه ای، کلمات بعدی باید با حرف بزرگ شروع شوند.
- اسامی متد ها باید از افعال باشد:

run();
runFast();
getBackground();

🔅 قرارداد نام گذاری متغیر ها (Variables):
- اسامی متغیر ها باید با حرف کوچک نوشته شود (lowercase)
- اسامی متغیر ها نباید با _ یا $ شروع شود هر چند هر دو مورد در اول اسم متغیر خطایی بدنبال نخواهد داشت.
- اسم متغیر ها باید کوتاه و با معنا باشد
- اگر اسم متغیر ترکیبی از دو یا چند کلمه است، کلمات بعدی باید با حرف بزرگ شروع شوند. برای مثال:

myName

myAge
💡 اسامی داده های منطقی معمولا با پیشوند is شروع میشود(بصورت سوال کوتاه که فقط دارای پاسخ ترو یا فالس باشد):

isAvailabe
isFound

در بعضی موارد نیز مخصوصا برای متد های با خروجی boolean میتوان از پیشوند has نیز استفاده کرد. برای مثال:

hasNextLine()
hasLisence()

🔅 قرارداد نام گذاری ثابت ها (constants):
- متغیر های ثابت باید با حرف بزرگ نوشته شوند.
- در صورتی که اسامی ثابت ها از چند حرف تشکیل میشود، از "_" برای جدا کردن اسامی باید استفاده شود:
final int MAX_VALUE = 999;
final int MIN_VALUE = 4;

#naming #name #naming_conventions #convetions #قرارداد
———
☕️ @piecejava