代码坏味道:神秘命名

神秘命名 (Mystery Names)

解释
神秘命名指的是代码中的变量、函数、类等命名不明确,不能清楚地传达其用途或意图。这样的命名会使代码难以理解和维护,因为开发者需要花费额外的时间去推测这些命名的含义。良好的命名应该清晰、简洁,并且能够准确反映其功能或用途。

例子

  1. 变量命名

    坏味道

    a = 5
    b = 10
    c = a + b
    

    重构

    number_of_apples = 5
    number_of_oranges = 10
    total_fruit = number_of_apples + number_of_oranges
    
  2. 函数命名

    坏味道

    def ff(x):
        return x * x
    

    重构

    def calculate_square(number):
        return number * number
    
  3. 类命名

    坏味道

    class D:
        def __init__(self, n, a):
            self.n = n
            self.a = a
    

    重构

    class Dog:
        def __init__(self, name, age):
            self.name = name
            self.age = age
    

总结
神秘命名会增加代码的认知负担,使得其他开发者(包括未来的自己)难以理解代码的意图和功能。通过采用有意义的、描述性的命名,可以显著提高代码的可读性和可维护性。

好的命名应该遵循以下原则:

  • 清晰:名字应该能够准确描述其用途或功能。
  • 简洁:名字不应过长,但也不应简化到无法理解的程度。
  • 一致:采用一致的命名约定和风格。
  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值