编程过程中的命名规则详解_编程常用命名规则有哪些-CSDN博客

本文链接：https://blog.csdn.net/weixin_45605541/article/details/144368313

文章目录

在编程过程中，良好的命名规则对于代码的可读性、可维护性和团队协作至关重要。本文将详细总结编程中的命名规则，包括使用单数还是复数、驼峰命名法还是下划线命名法等，并提供Python语言的示例。

变量命名

单数形式
适用于表示单个对象或实体的变量，使用下划线命名法（snake_case）：

user = get_user_by_id(user_id)
product = get_product_by_name(product_name)
order = create_order(user, product)

复数形式
适用于表示多个对象或实体的集合的变量，使用下划线命名法（snake_case）：
```
users = get_all_users()
products = get_all_products()
orders = get_orders_by_user(user_id)
```

类命名

类名通常使用单数形式，因为每个类表示一个单独的对象或实体：
使用驼峰命名法（CamelCase）：

class User:
    pass

class Product:
    pass

class Order:
    pass

函数和方法命名

函数和方法名通常使用动词或动词短语，描述函数或方法的行为：
使用下划线命名法（snake_case）：

def get_user_by_id(user_id):
    pass

def create_order(user, product):
    pass

def send_email(to_address, subject, body):
    pass

模块和包命名

模块和包名通常使用单数形式，但在某些情况下也可以使用复数形式，具体取决于模块或包的内容，使用下划线命名法（snake_case）：

# 单数形式
import user
import product

# 复数形式
import utilities
import helpers

数据库表命名

数据库表名通常使用复数形式，表示表中包含多个记录，使用下划线命名法（snake_case）：

CREATE TABLE users (
    id INT PRIMARY KEY,
    username VARCHAR(100),
    email VARCHAR(100)
);

CREATE TABLE products (
    id INT PRIMARY KEY,
    name VARCHAR(100),
    price DECIMAL(10, 2)
);

常量命名

常量名通常使用单数形式，但在某些情况下也可以使用复数形式，具体取决于常量的内容，使用全大写字母和下划线分隔（UPPER_SNAKE_CASE）：

MAX_CONNECTIONS = 100
DEFAULT_TIMEOUT = 30

# 复数形式
SUPPORTED_LANGUAGES = ['en', 'es', 'fr']

枚举类命名

枚举类名通常使用单数形式，表示枚举类型，使用驼峰命名法（CamelCase）：

from enum import Enum

class Status(Enum):
    SUCCESS = 1
    ERROR = 2
    PENDING = 3

文件命名

文件名通常使用单数形式，但在某些情况下也可以使用复数形式，具体取决于文件的内容，使用下划线命名法（snake_case）：

# 单数形式
user.py
product.py

# 复数形式
utilities.py
helpers.py

配置项命名

配置项名通常使用单数形式，但在某些情况下也可以使用复数形式，具体取决于配置项的内容,使用全大写字母和下划线分隔（UPPER_SNAKE_CASE）：

DATABASE_URL = 'postgres://user:password@localhost:5432/mydatabase'
DEBUG = True

# 复数形式
ALLOWED_HOSTS = ['localhost', '127.0.0.1']

模块级别变量

模块级别的特殊变量通常使用双下划线开头和结尾：

__all__ = ['User', 'Product']
__version__ = '1.0.0'

魔术方法命名

魔术方法（特殊方法）通常使用双下划线开头和结尾：

class User:
    def __init__(self, username):
        self.username = username

    def __str__(self):
        return self.username

私有变量和方法命名

私有变量和方法通常使用单下划线开头，这是一个约定，表示该变量或方法是“受保护的”，即它不应该在类外部使用，但这只是一个约定，并没有实际的访问限制。它仍然可以从类外部访问：

class User:
    def __init__(self, username):
        self._username = username  # 私有变量

    def _get_username(self):  # 私有方法
        return self._username

名称改写（Name Mangling）

双下划线开头且不以双下划线结尾的变量和方法，这是一个强制名称改写（name mangling）的机制，Python 会将其改写为 _ClassName__variable，以避免子类中的命名冲突。这使得该变量或方法在类外部更难访问，但仍然可以通过改写后的名称访问：

class Base:
    def __init__(self):
        self.__private = "I am private"

    def __private_method(self):
        return "This is a private method"

class Derived(Base):
    def __init__(self):
        super().__init__()
        self.__private = "I am also private"

    def __private_method(self):
        return "This is another private method"

base = Base()
derived = Derived()

print(base._Base__private)  # 输出: I am private
print(derived._Derived__private)  # 输出: I am also private

print(base._Base__private_method())  # 输出: This is a private method
print(derived._Derived__private_method())  # 输出: This is another private method