嘿,各位程序员!让我们来谈谈我们都做过但很少考虑的事情:命名我们的代码。
想象一下走进一个房间,所有东西都标有“thing1”、“thing2”、“thing3”。令人困惑,对吧?这正是其他开发人员对糟糕的代码名称的感受。
这是一个可怕的例子:
def f(x, y): return x * y
现在,更好的版本:
def calculate_rectangle_area(length, width): return length * width
看到区别了吗?第二个版本告诉你到底发生了什么。
好名字可以回答三个关键问题:
让我们看一个现实世界的例子:
# Bad: Unclear purpose def process(data): result = [] for item in data: if item > 0: result.append(item) return result # Better: Clear and intentional def filter_positive_numbers(number_list): return [number for number in number_list if number > 0]
要避免的常见错误:
# Avoid usr_cnt = len(users) # Prefer user_count = len(users)
# Confusing def get_user_info() def get_user_data() def get_user_details() # Clear def get_user_profile()
# Bad def calc(x, y, z): return x * y / z # Good def calculate_average_rate(total_revenue, total_hours, number_of_projects): return total_revenue / (total_hours * number_of_projects)
# Great naming example class CustomerAccount: MAX_WITHDRAWAL_LIMIT = 5000 def calculate_monthly_interest(self, balance): return balance * 0.05
名称应该在其环境中有意义。像状态这样的变量可以意味着任何东西。但 customer_state 或 order_processing_state 是一清二楚的。
# Unclear def update(state): pass # Clear def update_order_processing_state(order_status): pass
命名不仅仅是输入单词。这是沟通。您正在用代码讲述一个故事。让它成为别人想读的故事。
未来的你会感谢你的。你的队友会感谢你的。哎呀,甚至你的电脑也可能会给你一个虚拟的击掌✋。
以上是编程中的命名艺术:为什么好名字很重要!的详细内容。更多信息请关注PHP中文网其他相关文章!