Python注释有什么用
当前位置:贝知网>知识分享>设计开发>Python注释有什么用
Python注释有什么用
时间:2022-04-18 设计开发

Python注释有什么用

Python注释主要是有两种:1、使用【#】表示单行注释,单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后;2、使用三个单引号或三个双引号表示多行注释。

一、Python有什么注释

1、单行注释(行注释)

Python中使用#表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后。

如:# 这是单行注释

当单行注释作为单独的一行放在被注释代码行之上时,为了保证代码的可读性,建议在#后面添加一个空格,再添加注释内容。

当单行注释放在语句或表达式之后时,同样为了保证代码的可读性,建议注释和语句(或注释和表达式)之间至少要有两个空格。

2、多行注释(块注释)

当注释内容过多,导致一行无法显示时,就可以使用多行注释。Python中使用三个单引号或三个双引号表示多行注释。

注意:

(1)注释不是越多越好。对于一目了然的代码,不需要添加注释。

(2)对于复杂的操作,应该在操作开始前写上相应的注释。

(3)对于不是一目了然的代码,应该在代码之后添加注释。

(4)不要描述代码。一般阅读代码的人都了解Python的语法,只是不知道代码要干什么。

二、Python注释有什么用

给代码添加说明是注释的基本作用,除此以外它还有另外一个实用的功能,就是用来调试程序。

举个例子,如果你觉得某段代码可能有问题,可以先把这段代码注释起来,让Python解释器忽略这段代码,然后再运行。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。

在调试程序的过程中使用注释可以缩小错误所在的范围,提高调试程序的效率。

三、Python编码规则

PEP8 作为编码规范:

1)每一个import 只导入一个模块,尽量避免一次导入多个模块。

2)不要在每一行结尾加封号; 也不要用封号把两条命令放到一起。

3)每行不超过80个字符。若超过则用小括号()将其分行显示。不推荐反斜线

4)必要的空行。定义之间空两行,方法定义之间空一行。

5)运算符两侧,函数参数之间,建议用空格分隔

6)避免在循环中使用 + += 累加字符串。字符串是不可变的,这样做会创建不必要的临时对象。每个字符串加入列表,用join() 连接列表

7)适当使用异常处理结构提高程序容错性,但不能过多依赖异常处理结构,适当的显示判断还是必要的。

四、Python命名规范

1)模块名尽量短小,并且全部使用小写字母,可以使用下划线。

2)包名尽量短小,并且全部使用小写字母,不推荐使用下划线。

3)类名采用首字母大写格式。

4)模块内部的类使用下划线+Pascal 风格

5)函数,类的属性和方法的命名规则同模块类似。也是使用小写字母,多个字母用下划线分割。

6)常用命名时全部使用大写字母,可以使用下划线。

7)使用单下划线开头的模块变量或函数是受保护的,在使用from xxx import *语句从模块中导入时,这些变量或函数不能被导入。

8)使用双下划线开头的实例变量或方法时类私有的。