关于Python多行注释与单行注释的用法全在这了

开课吧开课吧小西2021-03-05 19:02

点赞
1
分享分享

注释用于向用户提示或解释某些代码的功能和作用,可以出现在代码的任何地方。在执行代码时,Python解释器将忽略注释,而不对其进行处理,就像它不存在一样。

在调试(Debug)程序的过程中,注释还可以用来临时移除无用的代码。

注释的最大作用是提高程序的可读性,没有注释的程序简直就是天书,让人吐血!

千万不要认为你自己写的代码规范就可以不加注释,甩给别人一段没有注释的代码是对别人的不尊重,是非常自私的行为;你可以喜欢自虐,但请不要虐待别人。

Python教程

很多程序员宁愿自己去开发一个应用,也不愿意去修改别人的代码,没有合理的注释是一个重要的原因。虽然良好的代码可以自成文挡,但我们永远不清楚今后阅读这段代码的人是谁,他是否和你有相同的思路;或者一段时间以后,你自己也不清楚当时写这段代码的目的了。

一般情况下,合理的代码注释应该占源代码的 1/3 左右。

Python 支持两种类型的注释,分别是单行注释和多行注释。

Python 单行注释

Python 使用井号#作为单行注释的符号,语法格式为:

# 注释内容

从井号#开始,直到这行结束为止的所有内容都是注释。Python 解释器遇到#时,会忽略它后面的整行内容。

说明多行代码的功能时一般将注释放在代码的上一行,例如:

#使用print输出字符串

print('Hello,World')

print('我曾今有一个梦想')

print('想去一个没人的地方')

print('和风一起飘荡逍遥自在')

print('你可知否远方在哪呢')

print('处处鸟语花香伴左右')

print('对着大海尽情地歌唱')

print('象征美好一天的生活')

说明单行代码的功能时一般将注释放在代码的右侧,例如:

print('欢迎学习python')#输出欢迎语!

a = 10 #变量定义

b = 8  #变量定义

print(a+b)#输出和

Python 多行注释

多行注释指的是一次性注释程序中多行的内容(包含一行)。

Python 使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容(都是在英文状态下输入),具体格式如下:

'''

使用 3 个单引号分别作为注释的开头和结尾

可以一次性注释多行内容

这里面的内容全部是注释内容

'''

或者

"""

使用 3 个双引号分别作为注释的开头和结尾

可以一次性注释多行内容

这里面的内容全部是注释内容

"""

多行注释通常用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息。

注意事项

1) Python 多行注释不支持嵌套,所以下面的写法是错误的:

'''

外层注释

    '''

内层注释

    '''

'''

2) 不管是多行注释还是单行注释,当注释符作为字符串的一部分出现时,就不能再将它们视为注释标记,而应该看做正常代码的一部分,例如:

print('''Hello,World!''')

print("""使用 3 个单引号分别作为注释的开头和结尾""")

print("#是单行注释的开始")

运行结果:

Hello,World!

使用 3 个单引号分别作为注释的开头和结尾

#是单行注释的开始

对于前两行代码,Python 没有将这里的三个引号看作是多行注释,而是将它们看作字符串的开始和结束标志。

对于第 3 行代码,Python 也没有将#号看作单行注释,而是将它看作字符串的一部分。

注释可以帮助调试程序

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

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

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

Python的发展前景还是很可观的,有对Python感兴趣的同学就赶快学习起来吧。以上就是小编今天为大家整理发布的“关于Python多行注释与单行注释的用法全在这了”一文,希望为正在学习Python的朋友提供学习参考,更多Python教程尽在开课吧广场Python教程频道!

有用1
分享