خب در این پست می‌خوام برخی قراردادهای نامگذاری در جاوا را بررسی کنم. در طول این مسیر مواردی چون نام گذاری‌های Package، Final,Static و … را به شما می‌گویم. این موارد فقط قرارداد هستند و نیازی به رعایت نیست. رعایت این موارد شما را برنامه‌نویس حرفه‌ای‌تری می‌کند و خوانایی کد شما را افزایش می‌دهد.
نامگذاری پکیج‌ها
- همواره از حروف کوچک استفاده کنید.
- نام پکیج هیچ‌گاه تکراری نیست.
- از hostname خود به عنوان یک عنوان اولیه در پکیج‌هاتون استفاده کنید.
- اوراکل یک‌سری قرارداد در این لینک جهت اسم‌گذاری پکیج‌ها قرار داده است.
- کاراکترهای غیرطبیعی را (Invalid Charachters) را با خط تیره جایگزین کنید.
- تلاش کنید از اسامی معنا دار و مرتبت با کاری که اون پکیج می‌خواهد بکند استفاده کنید.
- hostname شما در صورتی که با عدد شروع شده بود با _ جایگزینش کنید. مثال‌های زیر را ببینید:
package Switch.supplier.com; => com.supplier._com; package 1world.com; => com._1world.com;
نامگذاری کلاس‌ها
- از روش کوهان شتر!! استفاده کنید (به طور مثال به جای soroushtayyebi بنویسید SoroushTayyebi)
- نام کلاس باید اسم باشد ( از فعل و … استفاده نکنید)
- با حرف بزرگ شروع کنید.
- هر اسم در نام کلاس باید با حرف بزرگ شروع شود. (LinkedList)
نامگذاری Interface ها
- روش کوهان شتر استفاده کنید. (مانند کلاس‌ها)
- نام Interface باید حتما بیانگر کارایی آن باشد(مفهوم داشته باشد و آدم بفهمه که این Interface چه کاری قراره انجام بده)
نامگذاری متد‌ها
- از روش mixedCase استفاده میشه در نامگذاری (مثلا soroushTayyebi)
- معمولا از فعل‌ها در نامگذاری آن‌ها استفاده میشه. (getName)
نامگذاری ثوابت (Constants)
- فقط از حروف بزرگ در آن‌ها استفاده شود.
- کلمات با آندرلاین (Underline) جدا شوند. (MAX_SIZE)
نامگذاری متغیر‌ها
- از روش mixedCase استفاده میشه در نامگذاری (مثلا soroushTayyebi)
- با حروف کوچک شروع کنید.
- کلمات معنی دار انتخاب کنید.
- از Underline استفاده نکنید.
نامگذاری Type Parameters
این نوع را در پست قبلی کامل توضیح دادم. برای نامگذاری آن‌ها معمولا از این موارد استفاده می‌شود:
- E: مخفف Elements
- T: مخفف Type
- K: مخفف Key
- V: مخفف Value
در وبسایت اوراکل که گشت بزنید قراردادهای نامگذاری بیشتری را می‌بینید. من تلاش کردم برخی از آن‌ها را که مهمتر بودن و خوانایی کد شما را افزایش می‌دادند را در این مقاله ذکر کنم.
دیدگاهتان را بنویسید