命名(Naming)

變數與函數(Variables and Functions)

在做變數名稱命名時,應使用「小寫」且使用下底線分隔。

name = "Python"
job_title = "Software Engineer"
populated_countries_list = []
def get_data():
    pass

def calculate_tax_data():
    pass
# Wrong Way: id可能代表任何資料欄位的id,無法讓使用者快速了解
def get_user_info(id):
    db = get_db_connection()
    user = execute_query_for_user(id)
    return user
    
# Right Way: 直接告訴使用者這邊使用的是使用者id
def get_user_by(user_id):
    db = get_db_connection()
    user = execute_user_query(user_id)
    return user

物件(Class)

一般來說常用的模式會將個別單字的首字大寫(駝峰式大小寫Camel-Case)

class UserInformation:
    def __init__(self):
        pass

固定常數(Constants)

固定常數為專案中不大會去更新調整的變數,例如求解精確度,或是小數位數等,但仍保持調整空間。

TOTAL = 56
TIMEOUT = 6
MAX_OVERFLOW = 7

Last updated