代码整洁艰辛之道的分享

最新推荐文章于 2023-11-24 21:26:41 发布

置顶一只鸭鸭ya

最新推荐文章于 2023-11-24 21:26:41 发布

阅读量4.3k

点赞数

分类专栏：编程学习反思

本文链接：https://blog.csdn.net/qq_38875300/article/details/89043439

版权

编程学习反思专栏收录该内容

2 篇文章 0 订阅

订阅专栏

写出整洁的代码到底有多重要？

现实例子：经常有人抱怨读别人的代码好像吃别人的典明粥，如何把典明粥做得更好吃？

到底怎么样写才能写出门外汉都能懂的代码呢？

1、变量名要通俗易懂合乎规范

（1）、英语不好，拼音也是不错的选择，但是不能滥用拼音，易读就行，当然也不要拼音和英语一起用；

（2）、避免有多重意思的单词：deal 这个单词意思很含糊，deal可以正则操作，可以使切片操作，可以是运算操作等，具体是什么有点含糊，最好就是添加注释；

（3）、类名要大写等命名规范要了解：

模块尽量使用小写命名，首字母小写，不要用下划线；

类名使用驼峰，首字母大写，私有类下划线开头；

函数名一律小写，多个单词用下划线隔开；

变量名尽量小写, 多个单词用下划线隔开；

常量采用全大写，如有多个单词，使用下划线隔开；

我命名就比较喜欢用动宾结构这样就知道动作是什么，操作是什么，检查括号check_parenthesis，假如还是不清楚可以加上补语，做到什么状态。

2、减少魔术变量

django里面的反向解析这是用到了这点，在view方法增多，参数不断变化的情况下，url.py里面对应path可能需要不断修改，之前对应的链接全都要改，这样耦合性太强了。同样的情况，第一天需求是延时1s ，一周后需求改为延时0.5s，我所有延时1s的地方都要改。

通常我们会选择新建一个constant.py存放常量，例如：字符串（尤其是很长的键），逗号等一些符号，数值常量（0和1等），true和false，正则表达式，url等等。在pycharm里面选中了需要的魔术变量，ctrl + alt +c 帮助你生成常量。

# 之前爬虫项目的变量
# 商店名称
SHOP_NAME = "shop_name"
# 商店星级
SHOP_START = "shop_start"
# 商店地址
SHOP_ADDRS = "shop_addrs"

3、一个函数只做一件事

有一种夸张的说法只要是用到了and都是做了两件事，也是需要继续拆分。把一个函数只做一件事细致到极点的是for里面没有判断语句，尽量不要出现大量的if elif。

函数要短！

在pycharm里面选中了需要的提取的部分，ctrl + alt +m 帮助你提取。你很可能会看见Cannot perform refactoring when execution flow is interrupte.那很可能是因为有多个返回。

4、注释是非常必要的

很多人洋洋洒洒500行代码没有一句注释，其实每一个类，每一个方法都需要注释。尤其是一些临时变量，临时变量很多的时候，让你代码的可读性变差，a =1 b, c= 0, 0 n=head m=n, 这里的a, b, c表达不明确。

5、实例：

翻翻自己丑陋的代码，找到了一个。

检查一个程序的的花括号圆括号方括号是否匹对是返回1否则返回0。

你可以看见代码有很多冗余。

首先是提取魔术变量

EMPTYTOP = -1
OK = 1
FAIL = 0
match_tags = {')':'(', ']':'[', '}':'{',}

提取方法+添加注释：

match_tags = {')':'(', ']':'[', '}':'{',}


def push_tags(item, stack, top):
    """
    把左括号都添加到栈里面,左括号是指(、{、[
    :param item: 遍历表达式的元素
    :param stack: 存放左括号的栈
    :param top: 栈顶的指针
    :return: 返回栈顶指针的位置
    """
    if item == '(' or item == '[' or item == '{':
        top += 1
        stack.append(item)
    return top


def pop_tags(item, stack, top):
    """
    假如没有左括号只有右括号就会造成栈为空，最后check_parenthesis判断会得到栈空返回1，
    所以判断到栈空就需要返回终端标志interrupt，若为true那就在check_parenthesis返回0.
    :param item: 遍历表达式的元素
    :param stack: 存有左括号的栈
    :param top:返回栈顶位置
    interrupt：中断标志
    :return:返回栈顶指针的位置，以及中断标志
    """
    interrupt = False
    if len(stack) == 0 or stack[top] != match_tags[item]:
        interrupt = True
        return top, interrupt
    if stack[top] == match_tags[item]:
        stack.pop()
        top -= 1
    return top, interrupt

最后你会发现check_parenthesis就那么几行。我觉得读者会吐槽我的for循环里面有两个if，但是我觉得没有必要再套一层皮，不要为了整洁而整洁。其实我觉得check_parenthesis这个函数名起的不好。

def check_parenthesis(exps):
    if exps is None:
        return FAIL
    stack = []
    top = EMPTYTOP
    for item in exps:
        top = push_tags(item, stack, top)
        if item in match_tags:
            top, interrupt = pop_tags(item, stack, top)
            if interrupt:
                return FAIL
    if len(stack) == FAIL:
        return OK
    else:
        return FAIL

下面是测试：

if __name__ == '__main__':
    exp = '{[3*(1+2)]/12}*12'
    exp_err1 = '{[3*(1+2/12*12'
    exp_err2 = '3*1+2)/12]}*12'
    exp_err3 = ''
    exp_err4 = None
    exp_err5 = '{[3*(1+2)/12}*12'
    exp_err6 = '{}{[])())){{{]]]'

    """test"""
    a = check_parenthesis(exp)
    print("exp=", a)
    b = check_parenthesis(exp_err1)
    print("exp_err1=", b)
    c = check_parenthesis(exp_err2)
    print("exp_err2=", c)
    d = check_parenthesis(exp_err3)
    print("exp_err3=", d)
    e = check_parenthesis(exp_err4)
    print("exp_err4=", e)
    f = check_parenthesis(exp_err5)
    print("exp_err5=", f)
    g = check_parenthesis(exp_err6)
    print("exp_err6=", g)

测试结果：

exp= 1
exp_err1= 0
exp_err2= 0
exp_err3= 1
exp_err4= 0
exp_err5= 0
exp_err6= 0

6、不断的回顾

看之前自己写的代码不断地查找需要整洁的地方，假如你的代码是一行注释也没有，估计你连回顾的耐心也没有，在写的花费很多的时间，其实是在节省未来修改或者是回顾的时间，是十分值得的。我写这一篇文章的原因，首先是强哥和我聊天偶尔会提及相关情况，其次是学弟学习django时遇报错，我查看源码的时候发现一堆叫function和function_list的变量，花费了我一定的时间去理解，代码的整洁可能省的不仅省的是你未来的时间更是一个团队的时间。