Python中的变量与注释

一、变量与注释决定第一印象

1、变量和注释是代码里最接近自然语言的部分,其可读性至关重要。
2、即便是同一个算法,变量和注释的不同,也会给人截然不同的印象。

二、基础知识

1、Python变量赋值语法非常灵活!

(1)变量解包
动态解包语法中,只要使用星号表达式*variables作为变量名,就可以贪婪地捕获多个值对象,并将捕获到的内容已链表的形式赋值给variables

data = ['sam', 'apple', 'banana', 'orange', 100]
user_name, *fruit_names, cnt = data
print(furit_names)

此时,输出的结果为:

  • [ 'apple', 'banana', 'orange']

(2)单下划线变量名
下划线_既可以作为衣蛾个无意义的占位符用于接受变量,在Python交互式命令行中还默认保存了我们输入的上一个表达式的返回值:

>>> 'foo'.upper()
'FOO'
>> print(_)
FOO

2、编写注释的要点

  • 不要用注释来屏蔽代码,该删除就删除;
  • 注释是用来解释“为什么”、而不是用来复述,代码应当具有自解释性;

3、接口注释不要包含内部细节

接口注释是为使用者而撰写的,因此应当简明扼要的描述函数职责,而不必包含太多的方法内部细节。

4、可以用Sphinx格式文档或类型注解给变量标明类型

三、变量命名很重要

1、遵守PEP8原则

  • 普通变量采取蛇形命名法,max_value
  • 常量采取全部大写字母,MAX_VALUE
  • 仅内部使用,为其增加下划线前缀,_local_var
  • 与Python关键字冲突,在末尾添加下划线后缀,class_

2、描述性要强

在变量长度允许的范围内,变量名所指向的内容描述越准确越好。
当然,变量的命名需要考虑其使用场景,例如value作为描述性较弱的命名法,就很适合某个数学公式的计算结果。

3、要尽量短

利用结合上下文语境的方法,尽量缩短变量命名长度,一般不要超过4个单词,否则就会显得啰嗦。

4、要匹配类型

  • 布尔类型
    使用ishasallow等;

  • int / float类型

    • 释义为数字的单词,例如portageredius等;
    • _id为结尾的单词,例如user_id等;
    • lengthcount开头或结尾的单词;

5、可以使用一两个字母的超短命名法,但不要过度使用

6、其他技巧

  • 在同一段代码中,不要出现多个相似的变量命名,例如:user1user2user3
  • 可以尝试更换单次表达,来简化复合变量名,;例如用is_special替代is_not_normal

四、代码组织技巧

1、按照代码的职责组织代码:让变量定义靠近使用

不要在方法一开始就将所有变量定义好,什么时候用、什么时候再去定义。

2、适当定义临时变量可以提升代码可读性

很多时候我们会有一个非常长的if判断条件或表达式,这个时候我们可以抽象出一个新的可读性强的变量来接收判断条件。
直接翻译业务的代码往往不是好的代码,优秀的程序设计要从原始需求分解的基础上,进行恰到好处的抽象,这样才能满足可读性和可扩展性的要求。

3、不必要的变量会让代码冗余、啰嗦

很多时候,我们定义了一个变量后,紧接着就将其return了,这种情况下变量没有使用、也没有被编辑,完全是冗余的。

4、同一作用于内不要有太多变量

正如一个函数长度不应该超过50行,一个方法内部也不应该有太多的参数。
当出现参数过多的问题,一般可以通过将数据建模提炼为类,或者拆分函数来进行解决。

5、空行也是一种“注释”,适当的空行可以让代码更易读

在函数内部的段落间按照逻辑块,使用空行进行区分,能够很大程度提高整体的可读性。

五、代码可维护性技巧

1、保持变量的一致性

  • 名字一致性
  • 类型一致性

2、显式优于隐式:不要用locals()

虽然locals()方法能批量获取当前作用域所有局部变量,但看似简洁的背后,却是要求代码阅读者记住所有的变量!
“Python之禅”中有一句:

  • Explicit is better than implicit,显式优于隐式,很好的说明了问题

3、把接口注释当成一种函数设计工作

先写接口注释,再去写代码。如果你无法用一句有说服力的注释说明接口,就别写任何函数代码:此时的接口设计一定是混乱、冗余的。

参考内容:《Python工匠——案例、技巧与工程实践》

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/122217.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

基于 ARM+FPGA+AD平台的多类型同步信号采集仪开发及试验验证(一)上位机设计

采集仪上位机设计 本章开发了一款基于 C# 的上位机软件,用于对多类型同步信号采集仪的各项功能 进行操作。从采集仪的数据传输需求出发,上位机利用以太网 UDP 协议实现与采集仪 的数据交互,包括向采集仪发送控制信息与配置信息、接收采…

Vite+Vue3项目全局引入scss文件

前言 Sass 是世界上最成熟、最稳定、最强大的专业级CSS扩展语言!在日常项目开发过程中使用非常广泛,今天主要讲一下 ViteVue3 项目中该如何全局引入 scss 文件,引入混合 mixin 文件的不同配置。捎带说一下 Vue2 中的引入方式做一下简单的对比…

【linux】安装rpmrebuild

rpmrebuild是一种从已经安装的包中构建RPM文件的工具。它可以用于轻松构建修改后的包,并适用于任何使用RPM的Linux发行版。 访问地址 rpm rebuild download | SourceForge.net 选择版本 版本地址:版本地址 下载安装包 安装 rpm -ivh rpmrebuild-2.15…

2023大湾区杯粤港澳金融数学建模竞赛思路+模型+代码

目录 一.思路模型见文末名片,比赛开始第一时间更新 二.大湾区杯常用算法之主成分分析法(PCA) 三.MATLAB代码 四.国赛建模思路获取见此 一.思路模型见文末名片,比赛开始第一时间更新 二.大湾区杯常用算法之主成分分析法(PCA) 主成分分析法(PCA)是一种…

人工智能轨道交通行业周刊-第64期(2023.10.16-10.29)

本期关键词:北斗应用、供电智能运维、5G-R、铁路职称、星火大模型 1 整理涉及公众号名单 1.1 行业类 RT轨道交通人民铁道世界轨道交通资讯网铁路信号技术交流北京铁路轨道交通网上榜铁路视点ITS World轨道交通联盟VSTR铁路与城市轨道交通RailMetro轨道世界铁路那…

集合总结(Java)

Collection 常用方法 package com.test01;import java.util.ArrayList; import java.util.Collection; /*添加元素---boolean add(E e);移除元素---boolean remove(Object c);判断元素是否存在---boolean contains(Object c);*/ public class S {public static void main(Str…

关于多个elementui的cascader级联组件页面滚动渲染样式导致卡顿问题

如题,多个cascader级联组件,下拉选项含大量数据,滚动时会有实时样式重新渲染,导致CUP内存溢满而卡顿 小优化技巧:可加loading一次性加载完多个cascader级联组件后再允许页面滚动。 方法一:使用elementui中…

【2023.10.25练习】数据库-函数2

任务描述 本关任务:编写函数fun_2,实现指定学生的GPA计算。输入参数为学号,函数返回值为该生的GPA。 编程要求 在代码文件“step3/query1.sql”中实现函数fun_2; 在代码文件“step3/query2.sql”中实现在select命令中调用函数f…

LeetCode 917 仅仅反转字母 简单

题目 - 点击直达 1. XXXXX1. 917 仅仅反转字母 简单1. 原题链接2. 题目要求3. 基础框架 2. 解题思路1. 思路分析2. 时间复杂度3. 代码实现 1. XXXXX 1. 917 仅仅反转字母 简单 给你一个字符串 s ,根据下述规则反转字符串: 所有非英文字母保留在原有位置…

【计算机网络】认识协议

目录 一、应用层二、协议三、序列化和反序列化 一、应用层 之前的socket编程,都是在通过系统调用层面,如今我们来向上打通计算机网络。认识应用层的协议和序列化与反序列化 我们程序员写的一个个解决我们实际问题, 满足我们日常需求的网络程序, 都是在应…

如何快速解决d3dcompiler_43.dll缺失问题?五种方法快速解决

在计算机使用过程中,我们常常会遇到一些错误提示,其中之一就是“D3DCompiler_43.dll缺失”。这个错误通常会导致游戏、应用程序或系统无法正常运行。为了解决这个问题,我们需要采取一些修复方案来恢复缺失的文件。本文将介绍五个修复D3DCompi…

百度超级链XuperChain使用JavaSDK接入

环境 : ubuntu20 xuperchain 5.3 go 1.17 springboot : 2.5.14 前言 请提前启动好xchain的节点,我选择简单启一个xchain节点作为测试,并且使用默认端口37101 SpringBoot项目初始化 我们先进行SpringBoot项目的配置进行讲解,这里…

mongodb数据迁移的方法

这个方法只能将数据从一个mongo数据库转移到另一个mongo数据库 这个命令可以备份mongo数据(mongo数据库中的数据备份转换为文件) mongodump --host HOST --port PORT --username USERNAME --password PASSWORD --db DB -c COLLECTION --out OUT这个命令…

Flutter的The file name ‘xxxx.dart‘ isn‘t a snake_case identifier警告

文章目录 警告原因分析解决方法dart的一些命名规则变量和函数命名:类和类型命名:常量和枚举:文件命名:包命名:注释:命名一致性:避免缩写:可搜索的命名: 一些好习惯 警告 …

C++不能在子类中构造函数的初始化成员列表中直接初始化基类成员变量

在C中,派生类的构造函数可以调用基类的构造函数来初始化基类的成员变量。但是无法在派生类的构造函数的初始化列表中直接初始化基类的成员变量。 如果那样做,会报错:xx不是类xx的非静态成员或基类 例子 class StatusBase{ public:~StatusBas…

[已解决]安装的明明是pytorch-gpu,但是condalist却显示cpu版本,而且torch.cuda.is_available 也是flase

问题; 安装了gpu版本的pytorch,但是显示的torch.cuda.is_available()却是flase。 conda list查看 版本显示只有cpuonly 在网上找了半天,也没有解决办法。 仔细看了一下,发现,有个单独的包叫cpuonly,不知道…

33基于MATLAB的对RGB图像实现中值滤波,均值滤波,维纳滤波。程序已通过调试,可直接运行。

基于MATLAB的对RGB图像实现中值滤波,均值滤波,维纳滤波。程序已通过调试,可直接运行。 33 MATLAB、图像处理、维纳滤波 (xiaohongshu.com)

linux入门---多线程的控制

目录标题 线程库pthread_create如何一次性创建多个线程线程的终止线程的等待线程取消分离线程如何看待其他语言支持的多线程线程id的本质线程的局部存储线程的封装 线程库 要想控制线程就得使用原生线程库也可以将其称为pthread库,这个库是遵守posix标准的&#xf…

小美的修路(最小生成树练习)

本题链接:登录—专业IT笔试面试备考平台_牛客网 题目: 样例: 输入 3 4 1 2 3 1 1 2 2 0 1 3 1 0 2 3 3 0 输出 2 1 3 思路: 由题意,这里建造的城市需要修路,且每个城市之间可以联通,且 是 1 …

Nautilus Chain 联合香港数码港举办 BIG DEMO DAY活动,释放何信号?

在今年的 10 月 26 日 9:30-18:30 GMT8 期间,Nautilus Chain 联合香港数码港共同举办了 “BIG DEMO DAY” Web3 项目路演活动,包括Xwinner、Sleek、Tx、All weather、Coral Finance、DBOE、PARSIQ、Hookfi、Parallels、Fintestra 以及 dot.GAMING 等在内…