佳城建站 网站,高端网站建设浩森宇特,垣曲做网站,物流网站建设合同范本前言#xff1a;Hello大家好#xff0c;我是小哥谈。在使用Python语言进行编程的时候#xff0c;需要遵循一定的规范标准。本节课就带大家了解下Python语言在注释、缩进和编码方面的规范!~#x1f308; 目录
#x1f680;1.注释
#x1f680;2.代码缩进
#x1f68… 前言Hello大家好我是小哥谈。在使用Python语言进行编程的时候需要遵循一定的规范标准。本节课就带大家了解下Python语言在注释、缩进和编码方面的规范!~ 目录
1.注释
2.代码缩进
3.编码规范 1.注释
在Python中通常包括3种类型的注释分别是单行注释、多行注释和中文编码声明注释。
1单行注释
在Python中使用“#”作为单行注释的符号。从符号“#”开始直到换行为止“#”后面所有的内容都作为注释的内容并被Python编译器忽略。
语法如下
# 注释内容
单行注释可以放在要注释代码的前一行也可以放在要注释代码的右侧。例如下面的两种注释形式都是正确的。
第一种形式
# 要求输入身高单位为m米如1.75
heightfloat(input(请输入您的身高))
第二种形式
heightfloat(input(请输入您的身高)) # 要求输入身高单位为m米如1.75 说明在添加注释时一定要有意义即注释能充分解释代码的功能及用途。 2 多行注释
在Python中并没有一个单独的多行注释标记而是将包含在一对三引号……或者……之间并且不属于任何语句的内容都可视为注释这样的代码将被解释器忽略。由于这样的代码可以分为多行编写所以也称为多行注释。
语法格式如下 注释内容1
注释内容2
……或者 注释内容1
注释内容2
……多行注释通常用来为Python文件、模块、类或者函数等添加版权、功能等信息。例如下面代码将使用多行注释为demo.py文件添加版权、功能及修改日志等信息 版权所有*******©版权所有 文件名demo.py 文件功能描述****** 创建日期2023年12月31日 创建人小哥谈 注意在Python中三引号……或者……是字符串定界符。如果三引号作为语句的一部分出现时就不是注释而是字符串这一点要注意区分。 3 中文编码声明注释
在Python中还提供了一种特殊的中文编码声明注释该注释的出现主要是为了解决Python 2.x中不支持直接写中文的问题。虽然在Python 3.x中该问题已经不存在了。但是为了规范页面的编码同时方便其他程序员及时了解文件所用的编码建议在文件开始加上中文编码声明注释。
语法格式如下
# -*- coding:编码 -*-
或者
# coding编码
在上面的语法中编码为文件所使用的字符编码类型如果采用UTF-8编码则设置为utf-8。
例如指定编码为UTF-8可以使用下面的中文编码声明注释
# -*- coding:utf-8 -*- 2.代码缩进
Python不像其他程序设计语言如Java或者C语言采用大括号“”分隔代码块而是采用代码缩进和冒号“:”区分代码之间的层次。
缩进可以使用空格或者Tab键实现。其中使用空格时通常情况下采用4个空格作为一个缩进量而使用Tab键时则采用一个Tab键作为一个缩进量。通常情况下建议采用空格进行缩进。
在Python中对于类定义、函数定义、流程控制语句、异常处理语句等行尾的冒号和下一行的缩进表示一个代码块的开始而缩进结束则表示一个代码块的结束。
例如下面代码中的缩进为正确的缩进
heightfloat(input(请输入您的身高)) # 输入身高
weightfloat(input(请输入您的体重)) # 输入体重
bmiweight/(height*height) # 计算BMI指数# 判断身材是否合理
if bmi18.5:print(您的BMI指数为str(bmi)) # 输出BMI指数print(体重过轻 ~_~)
if bmi18.5 and bmi24.9:print(您的BMI指数为str(bmi)) # 输出BMI指数print(正常范围注意保持 (-_-))
if bmi24.9 and bmi29.9:print(您的BMI指数为str(bmi)) # 输出BMI指数print(体重过重 ~_~)
if bmi29.9:print(您的BMI指数为str(bmi)) # 输出BMI指数print(肥胖 ^_^)
Python对代码的缩进要求非常严格同一个级别的代码块的缩进量必须相同。如果不采用合理的代码缩进将抛出SyntaxError异常。 3.编码规范
在使用Python语言编程时遵循一定的代码编写规则和命名规范可以使代码更加规范化对代码的理解与维护都会起到至关重要的作用。
1编写规则
Python中采用PEP 8作为编码规范其中PEP是Python Enhancement ProposalPython增强建议书的缩写而“PEP 8”中的“8”表示版本号。PEP 8是Python代码的样式指南。
下面给出PEP 8编码规范中的一些应该严格遵守的条目。
A.每个import语句只导入一个模块尽量避免一次导入多个模块。
推荐写法
import platform
import sys
不推荐写法
import platform,sys
B.不要在行尾添加分号“;”也不要用分号将两条命令放在同一行。
下面所示的代码为不规范的写法
y torch.cat((xy, wh, conf), 4);
C.建议每行不超过80个字符如果超过建议使用小括号“()”将多行内容隐式的连接起来而不推荐使用反斜杠“\”进行连接。
例如如果一个字符串文本不能在一行上完全显示那么可以使用小括号“()”将其分行显示代码如下
s(我一直认为我是一只蜗牛。我一直在爬也许还没有爬到金字塔的顶端。但是只要你在爬就足以给自己留下令生命感动的日子。)
以下通过反斜杠“\”进行连接的做法是不推荐使用的
s我一直认为我是一只蜗牛。我一直在爬也许还没有爬到金字塔的顶端。\
但是只要你在爬就足以给自己留下令生命感动的日子。
D.使用必要的空行可以增加代码的可读性。一般在顶级定义如函数或者类的定义之间空两行而方法定义之间空一行。另外在用于分隔某些功能的位置也可以空一行。
E.通常情况下运算符两侧、函数参数之间、“,”两侧建议使用空格进行分隔。
F.应该避免在循环中使用“”和“”运算符累加字符串。这是因为字符串是不可变的这样做会创建不必要的临时对象。推荐将每个子字符串加入列表然后在循环结束后使用join()方法连接列表。
G.适当使用异常处理结构提高程序容错性但不能过多依赖异常处理结构适当的显式判断还是必要的。
2命名规范
命名规范在编写代码中起到很重要的作用虽然不遵循命名规范程序也可以运行但是使用命名规范可以更加直观地了解代码所代表的含义。
本节将介绍Python中常用的一些命名规范。
A.模块名尽量短小并且全部使用小写字母可以使用下划线分隔多个字母。例如game_main、game_register、bmiexponent都是推荐使用的模块名称。
B.包名尽量短小并且全部使用小写字母不推荐使用下划线。例如com.mingrisoft、com.mr、com.mr.book都是推荐使用的包名称而com_mingrisoft就是不推荐的。
C.类名采用单词首字母大写形式即Pascal风格。例如定义一个借书类可以命名为BorrowBook。
D.模块内部的类采用下划线“_”Pascal风格的类名组成。例如在BorrowBook类中的内部类可以使用_BorrowBook命名。
E.函数、类的属性和方法的命名规则同模块类似也是全部使用小写字母多个字母间用下划线“_”分隔。
F.常量命名时全部使用大写字母可以使用下划线。
G.使用单下划线“_”开头的模块变量或者函数是受保护的在使用 from ××× import *语句从模块中导入时这些变量或者函数不能被导入。
H.使用双下划线“__”开头的实例变量或方法是类私有的。
