百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

Python注释(多行注释和单行注释)用法详解

myzbx 2025-01-18 22:37 39 浏览

注释(Comments)用来向用户提示或解释某些代码的作用和功能,它可以出现在代码中的任何位置。Python解释器在执行代码时会忽略注释,不做任何处理,就好像它不存在一样。

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

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

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

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

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

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

Python单行注释

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

#注释内容

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

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

#使用print输出字符串
print("Hello World!")
print("开课吧广场")
print("https://topic.kaikeba.com/biancheng/python")
#使用 print输出数字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )12345678复制代码类型:[python]

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

print("https://topic.kaikeba.com/biancheng/python")  #输出Python教程的地址
print( 36.7 * 14.5 )  #输出乘积
print( 100 % 7 )  #输出余数123复制代码类型:[html]

Python多行注释

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

Python使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容,具体格式如下:

'''
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
'''12345复制代码类型:[python]

或者

"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""12345复制代码类型:[python]

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

注意事项

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

'''
外层注释
    '''
    内层注释
    '''
'''123456复制代码类型:[python]

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

print('''Hello,World!''')
print("""https://topic.kaikeba.com/biancheng/python""")
print("#是单行注释的开始")123复制代码类型:[html]

运行结果:

Hello,World!
https://topic.kaikeba.com/biancheng/python
#是单行注释的开始123复制代码类型:[html]

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

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

注释可以帮助调试程序

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

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

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

开课吧广场-人才学习交流平台

相关推荐

IT之家学院:如何修改Win10 Edge浏览器下载路径?

IT之家讯目前Win10Edge浏览器的默认下载路径不可修改,只能是系统“下载”文件夹,虽然用户可以通过移动该文件夹位置来间接达到修改目的,但Edge浏览器本身却无法修改。不过我们可以通过修改注册表...

Win 10自带Edge浏览器史上最强,好内核配了滥界面

微软在Win10上为我们带来了全新的Edge浏览器,而跌落神坛的IE正式被微软抛弃!随着Win10周年版更新的到来,Edge浏览器也带来了很多全新的特性,功能也更加完善!这让微软信心大增,微软甚...

Win10全新浏览器Microsoft Edge图标:致敬IE

IT之家讯今天早些时候,微软宣布了斯巴达(Spartan)浏览器项目的官方命名,微软在Windows10上集成的新浏览器的内核名为Edge,所以大家一定猜到了,它被命名为MicrosoftEdge...

Edge 84稳定版发布:优化集锦 默认禁用TLS 1.0/1.1

时隔6周时间,Edge浏览器的最新稳定版v84.0.522.40正式发布。新版本为IE模式改善了站点列表下载时间,在“以管理员身份运行”运行时允许用户登录浏览器等等。下载地址:https...

真相:Win10微软Edge和IE11浏览器图标相似的原因

IT之家讯5月7日消息,微软在Build2015大会上公布了Win10斯巴达浏览器的正式名称“MicrosoftEdge”以及正式图标,蓝色的“e”。这款新浏览器的图标让各位Windows老用户...

微软 Win11,20 多年来首个没有 IE 浏览器的 Windows 版本

IT之家6月26日消息在Windows10的生命周期中,你可能已经安装了IE浏览器、微软Edge的经典版本,以及新的Chromium驱动的Edge浏览器。这三个浏览器完...

微软宣布2022年6月15日停止支持IE浏览器:已推出25年

5月20日消息,在推出25年之后,微软最终决定于明年停止对IE浏览器的支持。多年来,这款网络浏览器基本上没有太多消费者使用,为此微软定于2022年6月15日完全停止对其支持,转...

我采访了一位 Pornhub 工程师,聊了这些纯纯的话题

成人网站在推动Web发展方面所起到的作用无可辩驳。从突破浏览器的视频能力限制,到利用WebSocket推送广告(防止被广告拦截器拦截),你必须不断想出各种聪明的办法,让自己处在Web技术创...

如何在 Microsoft Edge 中使用IE浏览器

随着微软Windows10,Windows11的推出,IE浏览器逐渐被抛弃,可是国内一些银行和政府网站还必须使用IE才能访问,下面我来解决这个问题。首先在MicrosoftEdge中启用IE模式...

IE浏览器无法加载网站时将自动跳转到Edge中打开

来源:cnBeta.COM目前微软已经将开发重心放在基于Chromium的新版Edge浏览器上,而传统的InternetExplorer则逐渐被淘汰。也就是说,如果你当前使用的是IE...

告诉你手机信号栏中E、H、T都是什么意思!

手机信号经常会出现E啊,H啊,T啊……之类的字母,每次出现的时候小编都会自动关机,觉得手机坏掉了……ORZ……那么这些字母具体表示些什么意思呢?如果是G,那么代表的是GPRS,指2.5G网络,此时网速...

比Chrome更适合国人用 Chromium版Edge横空出世

编辑微软终于正式发布Chromium内核的Edge浏览器了。这意味着微软放弃了自研浏览器内核,Windows自带浏览器也成为了Chrome的马甲。关于微软为什么要这么做,笔者曾经撰文分析,大家可以点...

Microsoft 新浏览器 Edge 将不再支持 ActiveX、VBScript 技术

Microsoft继宣布将推出将取代IE的全新浏览器Edge后,日前又再宣布Edge不会支持沿用以久的ActiveX、VBScript与BrowerHelperObjects(...

隐藏功能超炫酷 新版Edge浏览器还能这么玩

基于Chromium的新版Edge浏览器已经开放测试,但由于是测试期,可供用户选择的功能还比较少。不过有一部分功能已经内置到浏览器中,只是尚未开放而已。这就像汽车里的刷EPU一样,没事自己玩一玩,也是...

微软推出的新版Edge浏览器,让我抛弃用了5年的谷歌

随着新版Edge浏览器的发布,这个微软的亲儿子以崭新的面貌和大家见面啦。这次更新可谓是好评如潮,相比浏览器届的老大哥——谷歌浏览器,它少了些臃肿,但又多了一些独特的功能。今天,我就为大家介绍8...