加QQ81758415
快捷导航

命名难,难于上青天

[复制链接]
查看: 2484|回复: 0

3万

主题

0

帖子

234

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
234
发表于 2019-5-22 00:00:00 | 显示全部楼层 |阅读模式

“ 

        阅读本文大概需要 5 分钟。


 






        Quora 问答社区的一个开发者投票统计,程序员最大的难题是:如何命名(例如:给变量,类,函数等等),光是如何命名一项的选票几乎是其它八项的投票结果的总和。如何给变量命名,如何让它变得有意义成了程序员不可逾越的难题,这篇文章参考了 Clean Code ,提供 7 条命名建议,希望能在取名字的过程中给你带来一些帮助。



        以下都是基于 Python3.7 语法


[h2]
        1、使用有意义而且可读的变量名
[/h2]

        差




           

  •        
  1. current_date: str = datetime.date.today().strftime("%y-%m-%d")
复制代码


        看到 current_date,一眼就懂。


[h2]
        2、同类型的变量使用相同的词汇
[/h2]

        差:这三个函数都是和用户相关的信息,却使用了三个名字




           

  •        
           

  •        
           

  •        
  1. get_user_info()
复制代码
  1. get_user_data()
复制代码
  1. get_user_record()
复制代码


        极好:因为 Python 是一门面向对象的语言,用一个类来实现更加合理,分别用实例属性、property 方法和实例方法来表示。




           

  •        
  1. time.sleep(86400);
复制代码


        What the fuck, 上帝也不知道 86400 是个什么概念



        好




           

  •        
           

  •        
           

  •        
           

  •        
           

  •        
  1. address = 'One Infinite Loop, Cupertino 95014'
复制代码
  1. city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
复制代码
  1. matches = re.match(city_zip_code_regex, address)
复制代码
复制代码
  1. save_city_zip_code(matches[1], matches[2])
复制代码


        matches[1] 没有自我解释自己是谁的作用



        一般




           

  •        
           

  •        
           

  •        
           

  •        
           

  •        
  1. address = 'One Infinite Loop, Cupertino 95014'
复制代码
  1. city_zip_code_regex = r'^[^,\\]+[,\\\s]+(?P.+?)\s*(?P\d{5})?$'
复制代码
  1. matches = re.match(city_zip_code_regex, address)
复制代码
复制代码
  1. save_city_zip_code(matches['city'], matches['zip_code'])
复制代码

[h2]
        5、 不要强迫读者猜测变量的意义,明了胜于晦涩
[/h2]

        差




           

  •        
           

  •        
           

  •        
           

  •        
           

  •        
           

  •        
           

  •        
  1. locations = ('Austin', 'New York', 'San Francisco')
复制代码
复制代码
  1. for location in locations:
复制代码
  1. do_stuff()
复制代码
  1. do_some_other_stuff()
复制代码
  1. # ...
复制代码
  1. dispatch(location)
复制代码


        用 locations 表示,一看就知道这是几个地区组成的元组


[h2]
        6、不要添加无谓的上下文
[/h2]

        如果你的类名已经可以告诉了你什么,就不要在重复对变量名进行描述



        差




           

  •        
           

  •        
           

  •        
           

  •        
  1. class Car:
复制代码
  1. make: str
复制代码
  1. model: str
复制代码
  1. color: str
复制代码

[h2]
        7、使用默认参数代替短路运算和条件运算
[/h2]

        差:




           

  •        
           

  •        
           

  •        
  1. def create_micro_brewery(name: str = "Hipster Brew Co."):
复制代码
  1. slug = hashlib.sha1(name.encode()).hexdigest()
复制代码
  1. # etc.
复制代码


        这个应该能理解吧,既然函数里面需要对没有参数的变量做处理,为啥不在定义的时候指定它呢?

免责声明:

本站所发布的任何软件,全部来源于互联网,版权争议与本站无关。仅供技术交流,文献参考,如有侵权或不合适,请联系本人进行删除。学习网络技术是为了更好的提升自我安全意识。不允许将内容私自传播、销售或者其他任何非法用途!如有其它不良行为,本站会积极配合公安做好相关调查取证工作!

黑客联盟-www.545n.com
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

精彩推荐

让创业更简单

  • 反馈建议:hackhl@outlook.com
  • 客服电话:暂时没有
  • 工作时间:周一到周五9点~22点

云服务支持

黑客联盟,快速搜索

关注我们

Copyright 黑客联盟安全防护网  Powered by©  技术支持:    ( 闽ICP备18000419号-1 )