前言
Quora 问答社区的一个开发者投票统计,程序员最大的难题是:如何命名(例如:给变量,类,函数等等),光是如何命名一项的选票几乎是其它八项的投票结果的总和。如何给变量命名,如何让它变得有意义成了程序员不可逾越的难题,这篇文章参考了 Clean Code ,提供7条命名建议,希望能在取名字的过程中给你带来一些帮助。
以下都是基于Python3.7语法
1、使用有意义而且可读的变量名
差
ymdstr = datetime.date.today().strftime("%y-%m-%d")
鬼知道 ymd 是什么?
好
current_date: str = datetime.date.today().strftime("%y-%m-%d")
看到 current_date,一眼就懂。
2、同类型的变量使用相同的词汇
差 这三个函数都是和用户相关的信息,却使用了三个名字
get_user_info() get_client_data() get_customer_record()
好 如果实体相同,你应该统一名字
get_user_info() get_user_data() get_user_record()
极好 因为 Python 是一门面向对象的语言,用一个类来实现更加合理,分别用实例属性、property 方法和实例方法来表示。
class User: info : str @property def data(self) -> dict: # ... def get_record(self) -> Union[Record, None]: # ...
3、使用可搜索的名字
大部分时间你都是在读代码而不是写代码,所以我们写的代码可读且可被搜索尤为重要,一个没有名字的变量无法帮助我们理解程序,也伤害了读者,记住:确保可搜索。
差
time.sleep(86400);
What the fuck, 上帝也不知道86400是个什么概念
好
# 在全局命名空间声明变量,一天有多少秒 SECONDS_IN_A_DAY = 60 * 60 * 24 time.sleep(SECONDS_IN_A_DAY)
清晰多了。
4、使用可自我描述的变量
差
address = 'One Infinite Loop, Cupertino 95014' city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+"htmlcode">address = 'One Infinite Loop, Cupertino 95014' city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+"htmlcode">address = 'One Infinite Loop, Cupertino 95014' city_zip_code_regex = r'^[^,\\]+[,\\\s]+("color: #ff0000">5、 不要强迫读者猜测变量的意义,明了胜于晦涩差
seq = ('Austin', 'New York', 'San Francisco') for item in seq: do_stuff() do_some_other_stuff() # ... # Wait, what's `item` for again"htmlcode">locations = ('Austin', 'New York', 'San Francisco') for location in locations: do_stuff() do_some_other_stuff() # ... dispatch(location)用 locations 表示,一看就知道这是几个地区组成的元组
6、不要添加无谓的上下文
如果你的类名已经可以告诉了你什么,就不要在重复对变量名进行描述
差
class Car: car_make: str car_model: str car_color: str感觉画蛇添足,如无必要,勿增实体。
好
class Car: make: str model: str color: str7、使用默认参数代替短路运算和条件运算
差
def create_micro_brewery(name): name = "Hipster Brew Co." if name is None else name slug = hashlib.sha1(name.encode()).hexdigest() # etc.好
def create_micro_brewery(name: str = "Hipster Brew Co."): slug = hashlib.sha1(name.encode()).hexdigest() # etc.这个应该能理解吧,既然函数里面需要对没有参数的变量做处理,为啥不在定义的时候指定它呢?
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
标签:python,变量命名,建议
南强小屋 Design By 杰米
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
《魔兽世界》大逃杀!60人新游玩模式《强袭风暴》3月21日上线
暴雪近日发布了《魔兽世界》10.2.6 更新内容,新游玩模式《强袭风暴》即将于3月21 日在亚服上线,届时玩家将前往阿拉希高地展开一场 60 人大逃杀对战。
艾泽拉斯的冒险者已经征服了艾泽拉斯的大地及遥远的彼岸。他们在对抗世界上最致命的敌人时展现出过人的手腕,并且成功阻止终结宇宙等级的威胁。当他们在为即将于《魔兽世界》资料片《地心之战》中来袭的萨拉塔斯势力做战斗准备时,他们还需要在熟悉的阿拉希高地面对一个全新的敌人──那就是彼此。在《巨龙崛起》10.2.6 更新的《强袭风暴》中,玩家将会进入一个全新的海盗主题大逃杀式限时活动,其中包含极高的风险和史诗级的奖励。
《强袭风暴》不是普通的战场,作为一个独立于主游戏之外的活动,玩家可以用大逃杀的风格来体验《魔兽世界》,不分职业、不分装备(除了你在赛局中捡到的),光是技巧和战略的强弱之分就能决定出谁才是能坚持到最后的赢家。本次活动将会开放单人和双人模式,玩家在加入海盗主题的预赛大厅区域前,可以从强袭风暴角色画面新增好友。游玩游戏将可以累计名望轨迹,《巨龙崛起》和《魔兽世界:巫妖王之怒 经典版》的玩家都可以获得奖励。