Python入门教程+项目实战-6.3节: 学会写代码注释

最新推荐文章于 2024-07-29 21:16:24 发布

薯条老师-Python小班培训

最新推荐文章于 2024-07-29 21:16:24 发布

阅读量117

点赞数 1

分类专栏： Python入门教程文章标签： python 开发语言

文章著作权归广州市薯条橙子科技有限公司所有，未经许可，不得已任何形式进行传播

本文链接：https://blog.csdn.net/thereisadownloader/article/details/129712670

版权

Python入门教程专栏收录该内容

57 篇文章 6 订阅

订阅专栏

6.3.1 理解代码注释

在程序的编写过程中，通常会写注释，用来对关键的代码或程序中复杂的逻辑进行描述。代码注释面向的是程序员，也就是说它是给程序员看的。Python解释器在解释执行程序中的指令时，会跳过代码中的注释内容。

同学们在一开始学习编程的时候，就要养成写代码注释的习惯，将程序中关键的逻辑通过文字描述记录下来。这样在以后阅读的过程中，可以通过注释来理解程序中的关键逻辑。当然也不要过度注释，否则会影响代码的整体可读性。

6.3.2 代码注释符号

Python中的注释符号有英文中的三引号：

Python

'''注释内容'''
"""注释内容"""

和英文的#符号：

Python

# 后面的都是注释内容
#符号用来作单行注释，例如以下的代码:
state = 0
# 判断变量state指向的值是否等于0，如果等于0就执行冒号下方的代码
if state == 0:
   # 如果state指向的值等于0，就执行print("开心")
   print("开心")
else:
   # 否则执行print("不开心")
   print("不开心")

#符号用来进行单行注释，在Python中进行多行注释，需要使用一对英文的三引号'''或"""，三引号括住的即为注释内容。使用三引号进行多行注释的代码实例:

Python

state = 0
# 判断变量state指向的值是否等于0
if state == 0:
   """
   如果变量state指向的值为0，
   就执行print("开心")
   """ 
   print("开心")
else:
   """
   否则执行print("开心")
   """ 
   print("不开心")

Python解释器在解释执行脚本程序时，会跳过代码中的注释内容。对于Python解释器来说，程序中的代码相当于以下形式(不包含任何代码注释)：

Python

state = 0
if state == 0:
    print("开心")
else:
    print("不开心")

6.3.3 文件编码注释

Python源程序文件是文本文件，文本文件是由文本字符构成的文件，所谓的文件编码，是指文本文件中的字符编码方式。在Python版本2.X中，默认的字符编码为ASCII编码，如果使用非ASCII字符(例如汉字就是非ASCII字符)进行注释，Python在执行脚本程序时会抛出语法错误的异常信息。

计算机只能处理二进制，为了让计算机也能识别字符，需要将字符使用特定的数字编码进行表示。对此不熟悉的同学们，可以复习5.1节中的内容。

ASCII编码是一种字符编码规范，在这种编码规范中，最多只能表示256个字符。感兴趣的同学们，可以查阅相关资料，来查看ASCII编码所支持的字符。在Python版本3.X中，文件的默认字符编码为utf-8编码，可以直接在代码中使用汉字等其它字符进行注释。通过在文件头部指定编码注释，Python解释器会按照指定的编码方式来对文件的内容进行解码。编码注释主要有以下两种写法:

Python

(1) -*- coding=encoding_name -*-
(2) # coding=encoding_name

encoding_name表示具体的字符编码，例如指定按gbk编码的方式进行编码，写法为:

Python

-*- coding=gbk -*-
# 使用gbk进行编码
state = 0
# 判断变量state指向的值是否等于0
if state == 0:
    """
    如果变量state指向的值为0，
    就执行print("开心")
    """ 
    print("开心")
else:
    """
    否则执行print("开心")
    """ 
    print("不开心")

本教程采用的版本为Python3.11.0, 无需在文件头特别指定字符的编码方式。对于Python2.X系列的版本，同学们可以在文件头中指定utf-8编码:

Python