Python代码整洁之道02--有意义的命名,真的那么重要吗?~上篇
off999 2024-11-01 12:49 25 浏览 0 评论
一、Python学习中有哪些地方需要命名?
● 变量
● 函数
● 参数
● 类
● 源代码
● 源代码所在目录
都9102年,如果对这些概念不清楚,Python大星帮你开小灶
二、Python学习中需遵守的命名规则
1、名副其实
● 选个好名字需要花时间,但省下来的时间比花掉多
● 一旦发现更好的名称,就换掉旧的
● 读你代码的人(包括你自己)都会很开心
图1,名称d什么都没有说明。工作中谁要是这么写...
图2,选择体现本意的名称能让人更容易理解和修改代码
图3,没有复杂的表达式,只用到3个变量和2个常量
为什么难以说明图中的代码要做什么事?
问题不在于代码的简洁度
而是在于代码的模糊度
有3个问题,Python大星要提出批评:
● 函数名getThem是神马意思?
● x[0]是神马意思?
● 值4的意义是神马?
如何让图3中的代码变得有意义?
我们在开发一种扫雷游戏
我们发现盘面是
名为theList的单元格列表
那就将其名称修改为gameBoard
x[0]中的0是一种状态值
而这种状态值为4表示“已标记”
只要改为有意义的名称
代码就会得到相当程度的改进
Python并未提供如C/C++/Java一样的const/final修饰符。但是...
Python提供了新的方法实现常量:
通过自定义类实现常量
● 自定义常量类
● 结合图3改进代码
2、避免误导
● hp、aix和sco都不应该做变量名,因它们都是UNIX平台的专有名词
● 别用accountlist来指称一组账号,除非它真的是list类型,如果并非真的是个list,可以使用
accountgroup或者直接用accounts
● 尽量少使用外形相似的名称,区分会耗费时间
● 不用用小写字母l和大写字母O作为变量名,尤其在组合的时候。问题在于他们看起来完全像是常量“壹”和“零”
3、做有意义的区分
如果程序猿只是为了满足编译器或者解释器的需要而写代码,就会制造麻烦
● 以数字系列命名(a1、a2,......aN)
这样的名称纯属误导 --
完全没有提供正确的信息,没有提供导向作者意图的线索。
如果参数名改为source和destination,这个函数就像样的多。
● 废话是另一种没有意义的区分
假设你有Product类,还有ProductInfo或者ProductData类
那么他么名字虽然不同
意思却无区别
Info和Data就像a、an和the一样
是意义含混的废话
① variable一词永远不要出现在变量名中
② table一词永远不要出现在表名中
③ namestr会比name好吗?
难道name会是一个浮点数不成?
④ 如果缺少明确约定
变量moneyamount 就与money没区别
customerinfo与customer没区别
accountdata与account没区别
themessage也与message没区别
要区分名称,就要以读者能鉴别不同之处的方式来区分。
相关推荐
- Linux 网络协议栈_linux网络协议栈
-
前言;更多学习资料(包含视频、技术学习路线图谱、文档等)后台私信《资料》免费领取技术点包含了C/C++,Linux,Nginx,ZeroMQ,MySQL,Redis,fastdfs,MongoDB,Z...
- 揭秘 BPF map 前生今世_bpfdm
-
1.前言众所周知,map可用于内核BPF程序和用户应用程序之间实现双向的数据交换,为BPF技术中的重要基础数据结构。在BPF程序中可以通过声明structbpf_map_def...
- 教你简单 提取fmpeg 视频,音频,字幕 方法
-
ffmpeg提取视频,音频,字幕方法(HowtoExtractVideo,Audio,SubtitlefromOriginalVideo?)1.提取视频(ExtractVi...
- Linux内核原理到代码详解《内核视频教程》
-
Linux内核原理-进程入门进程进程不仅仅是一段可执行程序的代码,通常进程还包括其他资源,比如打开的文件,挂起的信号,内核内部的数据结构,处理器状态,内存地址空间,或多个执行线程,存放全局变量的数据段...
- Linux C Socket UDP编程详解及实例分享
-
1、UDP网络编程主要流程UDP协议的程序设计框架,客户端和服务器之间的差别在于服务器必须使用bind()函数来绑定侦听的本地UDP端口,而客户端则可以不进行绑定,直接发送到服务器地址的某个端口地址。...
- libevent源码分析之bufferevent使用详解
-
libevent的bufferevent在event的基础上自己维护了一个buffer,这样的话,就不需要再自己管理一个buffer了。先看看structbufferevent这个结构体struct...
- 一次解决Linux内核内存泄漏实战全过程
-
什么是内存泄漏:程序向系统申请内存,使用完不需要之后,不释放内存还给系统回收,造成申请的内存被浪费.发现系统中内存使用量随着时间的流逝,消耗的越来越多,例如下图所示:接下来的排查思路是:1.监控系统中...
- 彻底搞清楚内存泄漏的原因,如何避免内存泄漏,如何定位内存泄漏
-
作为C/C++开发人员,内存泄漏是最容易遇到的问题之一,这是由C/C++语言的特性引起的。C/C++语言与其他语言不同,需要开发者去申请和释放内存,即需要开发者去管理内存,如果内存使用不当,就容易造成...
- linux网络编程常见API详解_linux网络编程视频教程
-
Linux网络编程API函数初步剖析今天我们来分析一下前几篇博文中提到的网络编程中几个核心的API,探究一下当我们调用每个API时,内核中具体做了哪些准备和初始化工作。1、socket(family...
- Linux下C++访问web—使用libcurl库调用http接口发送解析json数据
-
一、背景这两天由于一些原因研究了研究如何在客户端C++代码中调用web服务端接口,需要访问url,并传入json数据,拿到返回值,并解析。 现在的情形是远程服务端的接口参数和返回类型都是json的字符...
- 平衡感知调节:“系统如人” 视角下的架构设计与业务稳定之道
-
在今天这个到处都是数字化的时代,系统可不是一堆冷冰冰的代码。它就像一个活生生的“数字人”,没了它,业务根本转不起来。总说“技术要为业务服务”,但实际操作起来问题不少:系统怎么才能快速响应业务需求?...
- 谈谈分布式文件系统下的本地缓存_什么是分布式文件存储
-
在分布式文件系统中,为了提高系统的性能,常常会引入不同类型的缓存存储系统(算法优化所带来的的效果可能远远不如缓存带来的优化效果)。在软件中缓存存储系统一般可分为了两类:一、分布式缓存,例如:Memca...
- 进程间通信之信号量semaphore--linux内核剖析
-
什么是信号量信号量的使用主要是用来保护共享资源,使得资源在一个时刻只有一个进程(线程)所拥有。信号量的值为正的时候,说明它空闲。所测试的线程可以锁定而使用它。若为0,说明它被占用,测试的线程要进入睡眠...
- Qt编写推流程序/支持webrtc265/从此不用再转码/打开新世界的大门
-
一、前言在推流领域,尤其是监控行业,现在主流设备基本上都是265格式的视频流,想要在网页上直接显示监控流,之前的方案是,要么转成hls,要么魔改支持265格式的flv,要么265转成264,如果要追求...
- 30 分钟搞定 SpringBoot 视频推拉流!实战避坑指南
-
30分钟搞定SpringBoot视频推拉流!实战避坑指南在音视频开发领域,SpringBoot凭借其快速开发特性,成为很多开发者实现视频推拉流功能的首选框架。但实际开发中,从环境搭建到流处理优...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)