代码整洁艰辛之道的分享

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中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

Java时间轮调度算法的代码实现

《Java时间轮调度算法的代码实现》时间轮是一种高效的定时调度算法,主要用于管理延时任务或周期性任务,它通过一个环形数组(时间轮)和指针来实现,将大量定时任务分摊到固定的时间槽中,极大地降低了时间复杂... 目录1、简述2、时间轮的原理3. 时间轮的实现步骤3.1 定义时间槽3.2 定义时间轮3.3 使用时