قوانین نامگذاری آبجکت ها در پایتون

امیرحسین بیگدلو 7 ماه قبل

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

دوره پیشنهادی: دوره آموزش عبارات منظم (regex) در پایتون

# قوانین نامگذاری آبجکت های پایتون

# از نام هایی که خیلی کلی یا لفظی هستند خودداری کنید. سعی کنید تعادل خوبی بین این دو حفظ کنید.
به عنوان مثال موارد زیر نمونه‌های مناسبی نیستند:

user_list
dict_to_store_defns_of_a_word
swapNums
moveInts

در عوض میتوانید از نام های زیر استفاده کنید:

user_info
word_definitions
swap_numbers
move_integers

 

# همچنین از حروف تکی بزرگ مانند A , X , D استفاده نکنید. در زمان استفاده از حال CamelCase، برای کلماتی که به شکل اختصاری هستند تمام حروف را به شکل بزرگ بنویسید مثلا HTTPServer

# نام آبجکت‌ ها را با عدد شروع نکنید. سعی کنید نام آبجکت ها ترکیبی از اعداد با حروف کوچک یا بزرگ انگلیسی و خط زیر (_) باشد.

# برای نام پکیج‌ ها و فایل ها فقط از حروف کوچک انگلیسی استفاده کنید. میتوانید از علامت خط زیر (_) برای چسباندن کلمات به یکدیگر استفاده کنید. هر چند که بهتر است تعداد کلمات کوتاه باشد.

# برای نامگذاری کلاس های پایتون حتما از حالت CapWords استفاده کنید. به این معنی که حرف اول هر کلمه بزرگ و بقیه حروف کوچک باشد مانند ThisNameValid. دقت کنید که کلاس های داخلی پایتون تماما از حروف کوچک استفاده میکنند. نام کلاس های exception باید با کلمه Error تمام شود مانند ScheduleError.

ویدیو پیشنهادی: آنالیز کد با pylint پایتون

# نام متغیرها باید تماما با حروف کوچک باشد. از علامت خط زیر (_) برای چسباندن چند کلمه به یکدیگر استفاده کنید مانند this_var_name.

# نام متدها باید تماما با حروف کوچک باشد. از علامت خط زیر (_) برای چسباندن چند کلمه به یکدیگر استفاده کنید مانند this_method_name. تمام متدها باید self را به عنوان اولین آرگومان داشته باشند. متدهای کلاسی(class method) باید cls را به عنوان اولین آرگومان داشته باشند.

# نام فانکشن ها باید تماما با حروف کوچک باشد. از علامت خط زیر (_) برای چسباندن چند کلمه به یکدیگر استفاده کنید مانند this_func_name.

# برای نامگذاری ثابت ها فقط از حروف بزرگ استفاده کنید. از علامت خط زیر (_) برای چسباندن چند کلمه به یکدیگر استفاده کنید مانند THIS_CONSTANT_NAME.

مطالب مشابه



مونگارد