قواعد نام گذاری در برنامه نویسی

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

نام گذاری PascalCase:

در این شیوه نام گذاری حرف اول همه کلمات با حروف بزرگ نوشته می شود و بین هر کلمه از هیج کاراکتری (space ، - ، _ و ...) استفاده نمی شود. کاربرد در نامگذاری کلاس ها و property ها.

مانند: ClientTarget, UserStatus

نام گذاری camelCase:

در این شیوه نام گذاری هر کلمه با حرف کوچک و سایر کلمات با حروف بزرگ نوشته می شود و بین هر کلمه از هیج کاراکتری (space ، - ، _ و ...) استفاده نمی شود. کاربرد در نامگذاری پارامترهای ارسالی به تابع، متغیر ها و کلیدها در json.

مانند: userId, deliveredAtTime

نام گذاری snake_case:

در این شیوه نام گذاری هر کلمه با _ (underline) از کلمه قبلی جدا می شود. برای نامگذاری function, method, variable .

مانند: user_id, received_at

نام گذاری kebab-case:

در این روش نام گذاری هر کلمه با - (dash) از کلمه قبلی جدا می شود. اسامی دیگه این سبک lisp-case, spinal-case, Train-Case. این نامگذاری تقریبا منسوخ شده است و برای query string در url مورد استفاده قرار می گیرد. سایر کاربرد های آن با نامگذاری snake case انجام می شود.

مانند: lazy-load, fox-name

استاندارد پایتون برای نامگذاری طبق استاندارد PEP8:

نکات تکمیلی:

• استاندارد نامگذاری constant ها به صورت CONSTANT_NAME انجام می شود.
• از به کاربردن حروف مختصر اجتناب کنید (کلمات مختصر کاربرد خودشان را دارند مثلا استفاده از url یا id صحیح است).
• قبل از نام interface ها از I(حرف آی در انگلیسی) استفاده کنیم (مثلا ICar).
• نام فایل ها را همانند نام کلاس اصلی قرار دهیم.
• در نام گذاری enum از نام های مفرد استفاده کنیم.