首页 > 编程笔记

Python注释的用法(3种)

注释是指在代码中对代码功能进行解释说明的标注性文字,让他人了解代码实现的功能,从而帮助程序员更好地阅读代码。注释的内容将被 Python 解释器忽略,并不会在执行结果中体现出来。

在 Python 中,通常包括3种类型的注释,分别是单行注释、多行注释和中文声明注释。

1、单行注释

在 Python 中,使用“#”作为单行注释的符号。

从符号“#”开始直到换行为止,“#”后面所有的内容都作为注释的内容,并被 Python 编译器忽略。
#注释内容
单行注释可以放在要注释代码的前一行,也可以放在要注释代码的右侧。例如,下面的两种注释形式都是正确的。
# 第一种形式
birthyear = input("请输入您的出生年份:")
birthyear = input("请输入您的出生年份:") # 第二种形式
在添加注释时,一定要有意义,即注释能充分解释代码的功能及用途。注释可以出现在代码的任意位置,但是不能分隔关键字和标识符。

2、多行注释

在 Python 中,并没有一个单独的多行注释标记,而是将包含在一对三引号('''……''')或者(”””……”””)之间的代码都称为多行注释。这样的代码解释器将忽略。由于这样的代码可以分为多行编写,所以也作为多行注释。

多行注释的语法格式如下:
'''
注释内容
'''
或者:
"""
注释内容
"""
多行注释通常用来为 Python 文件、模块、类或者函数等添加版权、功能等信息。

例如,下面代码将使用多行注释为程序添加功能、开发者、版权、开发日期等信息。多行注释也经常用来解释代码中重要的函数、参数等信息,以便于后续开发者维护代码。多行注释其实可以采用单行代码多行书写的方式实现。
'''
程序功能:输入出生年份,计算年龄
开发者:张三
开发日期:2022年05月
'''
"""
程序功能:输入出生年份,计算年龄
开发者:张三
开发日期:2022年05月
"""

3、中文编码声明注释

在 Python 中编写代码的时候,如果用到指定字符编码类型的中文编码,需要在文件开头加上中文声明注释,这样可以在程序中指定字符编码类型的中文编码,不至于出现代码错误。所以,中文注释很重要。

Python 3.x 提供的中文注释声明语法格式为:
#-*-coding:编码-*-
或者:
#coding=编码

例如保存文件编码格式为 UTF-8,可以使用下面的中文编码声明注释。
#-*-coding:utf-8-*-
一个优秀的程序员,为代码加注释是必须要做的工作。但要确保注释的内容都是重要的事情,无用的代码是不需要加注释的。

在上面的代码中,“-*-”没有特殊的作用,只是为了美观才加上的,所以这段代码也可以使用“#coding:utf-8”代替。

推荐阅读

副业交流群 关注微信公众号,加入副业交流群,学习变现经验,交流各种打法。