Python的编码规范(超详细)

article/2025/10/14 17:02:40

目录

  • 一、前言
  • 二、编写规范
  • 三、命名规范
  • 四、结语


一、前言

编码的规范性对代码的整体展现有着较大的影响。
先让我们看两张规范与不规范的代码截图来感受下。
先让我们看看不规范的吧。
python编码规范-不规范
看完有什么感觉吗?或许你会没有感觉,在让我们来看看我自认为很规范的做下对比。(有疑问可以评论,有时间我会回复的)
python编码规范-标准
将两张图片进行下。如果是你,你喜欢前面的代码还是喜欢后面的代码呢?


二、编写规范

python中采用 PEP8 (python 增强建议书) 作为编码规范。
PEP8具体地址:
https://peps.python.org/pep-0008/
我列举了些必要的编码规范,希望对你有帮助。

:记得点击每条规则后的小数字查看注脚。

1.不要在每行和末尾加分号“ ;”,也不要通过分号将两条命令放在一行上。1

2.每行的字符不要太长。建议用“()”进行隐式连接,而不推荐用反斜杠“\”进行连接。2

3.必要的空行可以增加代码的可读性。3

4.运算符/逗号等两侧进行空格。4

5.适当的使用异常处理结果提高程序的容错性。5


三、命名规范

命名规范在编写代码起到了非常重要的作用。
毕竟是规范,不用也可以,但是对于代码的理解或许会很难。代码大多数时候不是给你自己看的。所以改有的还得有。
1.模块名尽量短小,并且全部小写字母,可以使用下划线连接多个单词。例如:value、game_value等。(value是我经常用的一个单词)
2.包名尽量短小,并且全部使用小写字母,不推荐使用下划线。例如:box.top、game、fun等。
3.类名采用首字母大写形式(Pascal风格)。例如一个战斗机类—FighterPlane。
4.模块内部的类采用下划线“_”+Pascal 风格 的类名组成。例如,在战斗机类—FighterPlane 中新建一个内部类,制空战斗机—AirSuperiorityFighter(有时候也想简短,但臣妾做不到呀!)
5.函数、类的属性和方法的命名规范和模块相似,也是全部采用小写字母,单词间采用下划线“_”分隔。
6.使用双下划线“__”开头的实例变量或方法是私有的。

四、结语

这篇文章就这些了。感谢大家的阅读。如果感觉不错的话就给作者一个三连。
谢谢!


  1. python不同于其他编程语言,不需要用分号“ ;”将代码段分开。python的每一行就代表了一句代码。 ↩︎

  2. 我们可以将较长的代码用“()”将其隐式的链接起来。
    推荐-括号连接
    不推荐用反斜杠“\”连接。
    不推荐-反斜杠连接 ↩︎

  3. 通常在定义函数/类等情况下空两行,而方法定义和不同功能的代码块之间空两行。
    看下效果图:
    空行效果图 ↩︎

  4. 例图:
    运算符空格-1
    从中可以看出我只在“and”间进行了空格,没有在“==”和“=”两边空格。这是因为“==”和“=”两边空格有时没有必要。
    让我们来看看在它们两边加上空格后的样子。
    运算符空格-2
    下面这张的效果就不是很好了,特别是if语句那行。所以,不是一定要空格的,不仅要注意可读性,还要考虑整体展现的效果。毕竟规矩是死的,人是火的。 ↩︎

  5. 异常处理语句也就是try语句。可以用但不能过于依赖。 ↩︎


http://chatgpt.dhexx.cn/article/q5xaWGuc.shtml

相关文章

标准的Java编码规范手册

编码规范体现出一个开发者的基本素质,良好的编码规范可以提高团队编码的效率,避免很多不必要的问题。今天分享一个标准的Java编码规范给大家,希望对于大家今后的开发工作带来帮助。 编码规范的意义 在项目开发维护中,编码…

Java编码规范总结(参考腾讯编码规范)

一、java文件组织 文件组织规则:由于超过2000行的程序难以阅读,应该尽量避免出现超过2000行的程序。一个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联,可以将它们和公共类放入同一个源文件。公共类必须是这个…

编码体系与规范

编码体系与规范 网页编码是指网页中字符的编码方式。目前国内常见的网页字符编码主要有utf-8、gbk、gb2312,其中 utf-8为国际化编码,在各国各地区的网站中都很常见,可以说是最通用的字符编码。此外,有些日本网页会使用EUC-JP、SH…

python编码规范

PE8基本规范: 建议修改在使用的 IDE 中修改 PEP8 的每行字数不超79字符规范,可修改为 Django 建议的 119 字符 一、python编码规范: (一)代码编码: 1、国际惯例,文件编码和 Python 编码格式全部为 utf-8 ,…

JAVA编码规范

命名风格 代码命名不能以下划线或者美元符号开头或者结尾代码命名不能以中文拼音或者中文拼音与英文混合方式类名使用UpperCamCamelCase风格,但DO、PO、DTO、VO、BO等除外方法名、参数名、变量名统一使用lowerCamelCase,必须遵守驼峰命名常量名全部大写…

【编码规范篇】| C#编码规范 代码规范总结,包括命名规范,代码规范 注释规范等

🎬 博客主页:https://xiaoy.blog.csdn.net 🎥 本文由 呆呆敲代码的小Y 原创,首发于 CSDN🙉 🎄 学习专栏推荐:Unity精品学习专栏 🌲 游戏制作专栏推荐:游戏制作分享 &…

编码的一些基本规范

1. 数据库表设计 Rule 1. 【强制】表名小写,多个word之间用英文下横线_分隔Rule 2. 【强制】表名普通表前缀t_;临时表tmp_;备份表bak_;视图v_;主键pk_;外键fk_;唯一索引uix_;普通索引idx_Rule 3. 【强制】关系表统一用relation结尾Rule 4. 【强制】表名和业务字段必…

编码规范汇总【持续更新】

目录 前言规范标准C规范C#规范 规范记录命名硬编码单例类【线程安全】Qt定义类【隐式内存共享】 前言 作为软件工程师,出产物就应该具备工程的健壮性和美观性。因此代码规范是作为软件工程师的职业素养。但总所周知,程序员的工作基本就是在维护一座屎山…

51单片机串口波特率

SCON SCON 0X50工作方式1 波特率需要使用定时器1 波特率 ((2^SMOD)/32) * (定时器溢出率) 定时器溢出率 系统时钟/指令周期/装载数 SMOD 1 ,波特率加倍 TH1 TL1 -(FOSC / INSTRU_CYCLE / 32 / BAUD); //Set auto-reload vaule TR1 1;

关于51单片机串口1发送完整的数据包

关于51单片机串口1发送完整的数据包 在参考这样的协议的条件下我们想发送一套完整的数据包该如何发送呢?可以设计这样的程序。 1. 串行口1接收特定包头数据包函数。 参数: Uart_Rec_Data:串口接收到的数据 ; USER_Get_DataPacket: 数据存储目…

51单片机串口收发

#include<reg52.h>#define uint unsigned int #define uchar unsigned char/*本代码实现串口的收发功能&#xff0c;PC发送什么单片机就接收什么&#xff0c; 然后单片机又把接收的发出去&#xff0c;本次编写了在发送单个字符串 函数上添加了字符串函数&#xff0c;方便…

学习51单片机串口工作方式及应用

1.串口控制寄存器SCON SM2:多机通信控制位 REN:允许接收控制位 TB8:发送第九位数据 RB8:接收第九位数据 TI:发送中断标志位 RI:接收中断标志位 2.电源控制寄存器PCON 当SMOD位为1&#xff0c;则串行口方式1、方式2、方式3的波特率加倍。 3.串口的工作方式 &#xff08;1…

关于51单片机串口通信的相关知识(寄存器)

一、51单片机串口概念 1、51单片机的串行口 51单片机的串行口是一个可编程全双工的通信接口&#xff0c;具有UART&#xff08;通用异步收发器&#xff09;的全部功能。 2、51单片机的硬件连接 简单双向串口通信有两根数据通信线&#xff1a; 发送端TXD&#xff08;Transmit Da…

C51单片机串口点亮一个led

C51单片机串口点亮一个led 因为最近要用到51的串口做一些通信&#xff0c;这里写一个点led的程序记录一下。 说是一个led&#xff0c;其实可以随意多个。 主要使用到的东西&#xff1a; STC89C52芯片&#xff0c;USB转TTL下载器&#xff0c;led灯若干&#xff0c;面包板&am…

51单片机 串口

串口说白了&#xff0c;就是初始化后&#xff0c;用中断接收发送字符而已。 TXD 是 80C51 单片机的P3.1口&#xff0c;RXD 是80C51 单片机的 P3.0口 T1 溢出率 是定时器1的溢出率 &#xff0c;SMOD是发送速率倍频的16分频&#xff0c;T1每溢出一次发送一位&#xff0c;每次发送…

【记录】一次51单片机串口乱码问题排查

【记录】一次51单片机串口乱码问题排查 项目场景问题描述原因分析解决方案结语 项目场景 在51串口收发仿真实验中使用两个单片机互相通信&#xff0c;程序设定A上电1s后通过串口以16进制给B发送AA,直到B收到AA后回复BB&#xff0c;当A机确认收到AA后开始发送数据&#xff0c;若…

## 51单片机串口通讯

1&#xff0c;接线方式&#xff1a; RXD: 数据输入引脚&#xff1b;对应stc89的P3.0口&#xff1b; TXD&#xff1a;数据的发送端口;对应P3.1口&#xff1b; 注意&#xff1a;单片机的的串口TX&#xff0c;RX与外设交叉接线&#xff1b; 2串口编程要素 输出/输入数据缓冲器S…

51单片机串口通信详解

文章目录 前言一、计算机通信简介二、串口通信简介1、简介2、同步通信和异步通信2.1 同步通信2.2 异步通信 3、串行通信的传输方式4、串口通信硬件电路5、常见接口介绍 三、串口相关寄存器详解1、特殊功能寄存器SCON2、PCON寄存器3、TMOD寄存器&#xff08;定时器工作方式寄存器…

51单片机串口接收处理

目的: 通过51单片机串口外设功能&#xff0c;来对一组数据进行处理&#xff0c;新手刚刚入门可能会将串口接收到的一个数据直接赋值给一个变量&#xff0c;然后用这个变量做相应功能&#xff0c;可是这样写的不稳定性太高了&#xff0c;有可能会接收不到你要的那个数据&#…

51单片机串口通信原理

计算机串行通信基础 通信有串行通信和并行通信两种方式 串行通信&#xff1a; 将数据字节分为一位一位的形式在一条数据线上逐个传送。如下图所示 串行通信特点&#xff1a;传输线少&#xff0c;长距离传送时成本低&#xff0c;且可以利用电话网等现成设备&#xff0c;但数据的…