一、前言
注释,是指在代码中对代码功能进行解释说明的标准性文字,可以提高代码的可读性。注释的内容被Python解释器忽略,并不会在执行结果中提现出来。
在Python中,通常包括3种类型的注释,分别是单行注释、多行注释和中文声明注释。
二、单行注释
在Python中,使用“#”作为单行注释的符号。从符号“#”开始直到换行为止,其后面所有的内容都作为注释的内容而被Python编译器忽略。
语法如下:
# 注释的内容
单行注释可以放在要注释代码的千一行,也可以放在要注释代码的右侧,例如下面的两种注释形式都是正确的。
第一种形式:
# 要输入的年份,必须是四位数字的,如1999
year = int(input("请输入您的出生年份:"))
第二种形式:
year = int(input("请输入您的出生年份:")) # 要输入的年份,必须是四位数字的,如1999
三、多行注释
在Python中,并没有一个单独的多行注释标记,而是将包含在一对三引号("""…""")或(’’’…’’’)之间的代码都称为多行注释。这样的代码解释器将忽略。由于这样的代码可以分为多行编写,所以也作为多行注释。
语法格式如下:
"""
注释内容1
注释内容2
......
"""
或者
'''
注释内容1
注释内容2
......
'''
多行注释通常用来为Python文件、模块、类或者函数等添加版权信息、功能信息,例如:下面代码将使用多行注释为程序添加功能、开发者、版权权、开发日期等信息。
'''
信息加密模块
开发者:白小白
版权所有:白小白
2022年2月
'''
多行注释也经常用来解释代码中重要的函数、参数信息,以便于后续开发者维护代码,例如:
'''
库存类主要函数方法
update:改/更新
find:查找
delete:删除
create:添加
'''
多行注释其实可以采用单行代码多行书写的方式实现,如上面的多行注释可以写成如下形式:
# 库存类主要函数方法
# update:改/更新
# find:查找
# delete:删除
# create:添加
四、中文编码声明注释
在Python中编写代码的时候,如果用到指定字符编码类型的中文编码,需要在文件开头加上中文声明注释,这样可以在程序中指定字符编码类型的中文编码,不至于出现代码错误。所以说,中文注释很重要。Python3.X提供的中文注释声明语法格式如下:
# -*- coding: 编码 -*-
或者
# coding=编码
例如保存文件编码格式为UTF-8,可以使用下面的中文编码声明注释:
# -*- coding: utf-8 -*-
一个优秀的程序员,为代码加注释是必须要做的工作。但要确保注释的内容都是很重要的事情,看一眼就知道是干什么的,无用的代码是不需要加注释的。
五、说明
在上面代码中,“-*-”没有特殊作用,这是为了美观才加上的,所有上面的代码也可以使用“coding=utf-8”代替。
为了让读者透彻理解程序中的代码,本文多数代码都进行了注释。在实际开发中,读者只要对关键代码进行注释就可以了,不必像本文一样,行行都写注释。