代码整洁艰辛之道的分享

2023-10-29 20:10

本文主要是介绍代码整洁艰辛之道的分享,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

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

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

目录

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

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

2、减少魔术变量

3、一个函数只做一件事

4、注释是非常必要的

5、实例:

6、不断的回顾


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

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

def check_parenthesis(exps):if exps is None:return FAILstack = []top = EMPTYTOPfor item in exps:top = push_tags(item, stack, top)if item in match_tags:top, interrupt = pop_tags(item, stack, top)if interrupt:return FAILif len(stack) == FAIL:return OKelse: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 = Noneexp_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的变量,花费了我一定的时间去理解,代码的整洁可能省的不仅省的是你未来的时间更是一个团队的时间。

这篇关于代码整洁艰辛之道的分享的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/303088

相关文章

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

利用Python调试串口的示例代码

《利用Python调试串口的示例代码》在嵌入式开发、物联网设备调试过程中,串口通信是最基础的调试手段本文将带你用Python+ttkbootstrap打造一款高颜值、多功能的串口调试助手,需要的可以了... 目录概述:为什么需要专业的串口调试工具项目架构设计1.1 技术栈选型1.2 关键类说明1.3 线程模

Python Transformers库(NLP处理库)案例代码讲解

《PythonTransformers库(NLP处理库)案例代码讲解》本文介绍transformers库的全面讲解,包含基础知识、高级用法、案例代码及学习路径,内容经过组织,适合不同阶段的学习者,对... 目录一、基础知识1. Transformers 库简介2. 安装与环境配置3. 快速上手示例二、核心模

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符(formatspecifier)快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指

使用Python实现全能手机虚拟键盘的示例代码

《使用Python实现全能手机虚拟键盘的示例代码》在数字化办公时代,你是否遇到过这样的场景:会议室投影电脑突然键盘失灵、躺在沙发上想远程控制书房电脑、或者需要给长辈远程协助操作?今天我要分享的Pyth... 目录一、项目概述:不止于键盘的远程控制方案1.1 创新价值1.2 技术栈全景二、需求实现步骤一、需求

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

《Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码》:本文主要介绍Java中日期时间转换的多种方法,包括将Date转换为LocalD... 目录一、Date转LocalDateTime二、Date转LocalDate三、LocalDateTim

jupyter代码块没有运行图标的解决方案

《jupyter代码块没有运行图标的解决方案》:本文主要介绍jupyter代码块没有运行图标的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录jupyter代码块没有运行图标的解决1.找到Jupyter notebook的系统配置文件2.这时候一般会搜索到

Python通过模块化开发优化代码的技巧分享

《Python通过模块化开发优化代码的技巧分享》模块化开发就是把代码拆成一个个“零件”,该封装封装,该拆分拆分,下面小编就来和大家简单聊聊python如何用模块化开发进行代码优化吧... 目录什么是模块化开发如何拆分代码改进版:拆分成模块让模块更强大:使用 __init__.py你一定会遇到的问题模www.