山地人

Python 注释

山地人
山地人
2021-07-02

注释

在书写代码的时候,为了让日后阅读和维护代码的方便,在编写代码的过程中,我们会留下一些对代码功能或者注意事项的一些解释说明,这就是代码注释

和绝大多数编程语言一样,Python支持三种书写注释的方式:单行注释多行注释文档注释

对于单行注释和多行注释,都不会改变程序运行时的逻辑。他们在代码执行的时候会被忽略掉。

单行注释

很多时候,我们对代码进行注释都只是书写一些简短的单行语句,所以单行注释是三种注释中使用频率最高的注释。

# total是总价
total = 230

我们可以在要注释的语句上方用#开头,后面的内容就会被当成是注释内容。

另外你也可以把单行注释写在要注释的语句的后面,像这样:

total = 230 # total是总价

修改单行注释,将其放置到注释行内容的结尾,分别观察两次运行结果是否一致。

如果要注释的内容比较多,有好几行,这个时候你依然可以使用多条单行注释来处理。

# total: 总价
# 用于计算购物车内全部商品的总价
total = 230

多行注释

对于多行内容的注释,Python还提供了专门用于这种场景的多行注释。使用方法为: 用三个"""作为开头,最后以"""结尾。

"""total: 总价
用于计算购物车内全部商品的总价"""
total = 230

另外你可以用三个连续的单引号来作为多行注释的开头和结尾的标志,如:''' 注释内容 '''

'''total: 总价
用于计算购物车内全部商品的总价'''
total = 230

这两种写法都是等价的多行注释

注意:如果你使用三个单引号作为多行注释的开头,那么结尾也要使用三个单引号作为结尾,不能单引号和双引号混用。

文档注释

Python允许我们为函数方法以及模块编写文档注释。文档注释的书写也是采用的多行注释的风格。 但文档注释的书写位置必须放在紧接着函数方法以及模块定义的下一行。

def calcTotal():
'''计算商品总价'''
total = 30
return total

上面的'''计算商品总价'''就是为calcTotal函数编写的一个文档注释。

和单行注释、多行注释不同的是,我们可以通过__doc__获取到对应模块的文档注释。

这里需要注意doc前后各有两个_下划线。

calcTotal.__doc__

通过上面的方式来获取calcTotal中定义的文档注释。

小练习

尝试将上面文档注释中的单引号都换成双引号,看文档注释是否依然有效。

至此,本篇教程也到了该和你说再见的时候了,我们下期再见。

学完本篇互动教程,如果你觉得体验不错,可以把网页链接发送给你的小伙伴,让他/她也来感受一下。当然,你也可以继续看看网站上其他的的互动教程,希望`idev365`能够给你带来收获。

学习教程的过程中碰到了问题,或者对idev365有什么改进意见和想法,欢迎加入idev365微信内测群,和山地人交流你的想法。