Python从入门到精通
上QQ阅读APP看书,第一时间看更新

1.3 代码中的注释

注释用于对某一段代码的含义或逻辑作文字性的描述。注释的内容会被编译器或解释器忽略。程序员在编写代码的过程中通常会写注释,目的是增强代码的可读性。

1.3.1 单行注释

Python规定使用字符#来表示单行注释。单行注释,顾名思义,只能用来注释一行。

# 这是Python中的单行注释,注释的内容会被解释器忽略

笔者有话说

程序员应该养成写注释的习惯。写注释可以增强代码的可读性,方便后期的软件维护。例如,编写完一个函数,一段时间后需要对这个函数进行功能上的修改,这就是维护。

1.3.2 多行注释

在Python中使用一对英文的三引号'''或"""来表示多行注释。多行注释,顾名思义,可以用来注释多行内容。

'''
这是Python中的多行注释,与单行
注释一样,注释的内容会被Python解释器忽略。
多行注释的内容必须在成对的三引号里面。
'''
"""
这也是多行注释 
"""

1.3.3 编码注释

初学者在编写Python代码时,喜欢用汉字来进行注释。在Python 2.x版本中,脚本文件的字符编码默认为ASCII码。如果在源程序中使用非ASCII字符来进行注释,Python解释器在解析时会抛出语法错误的异常信息。在Python 3.x版本之后,脚本文件的字符编码默认为UTF-8编码,可以直接使用汉字进行注释。

在文件头部加一行编码注释,Python解释器会按指定的编码方式对源程序进行解析。

编码注释有以下两种写法。

# coding=encoding_name
# -*- coding:encoding_name -*-

其中,encoding_name表示具体的编码字符集。例如,指定源程序的字符集为UTF-8编码,则写法如下。

# -*- coding:utf-8 -*-

编程小知识

对于Python 2.x版本,在对Python源程序指定UTF-8编码时,汉字能正常显示,初学者只需简单地在文件头加一行“# -*- coding:utf-8 -*-”即可。

1.3.4 技术总结

本节主要包含以下两个重要的知识点,请读者多加巩固。

注释用于对某一段代码的含义或逻辑作文字性的描述,注释的内容会被编译器或解释器忽略。在Python中使用#符号作单行注释,使用一对英文的三引号'''或"""作多行注释。

在文件头中进行编码注释,可以指定特定的编码。