【自学Python】Python注释

旧城等待， 2024-03-30 15:56 105阅读 0赞

> 文章来源嗨客网（www.haicoder.net）

## Python注释 ##

### Python注释教程 ###

用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性。一旦程序中某部分内容被注释掉，则该内容将会被 **Python** 解释器忽略，换句话说，此部分内容将不会被执行。

注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来，再用代码去体现。

### Python注释作用 ###

注释不仅可以用来解释程序某些部分的作用和功能（用自然语言描述代码的功能），在必要时，还可以将代码临时移除，是调试程序的好帮手。

通常而言，合理的代码注释应该占源代码的 1/3 左右。

### Python注释形式 ###

Python 提供了三种注释的形式单行注释 、多行注释和中文编码声明注释。

#### 单行注释 ####

##### 使用 #####

Python 的单行注释使用的是 `#` 号。Python的单行注释可以嵌套使用。

##### 基本语法 #####

# 注释内容

#### 多行注释 ####

##### 使用 #####

Python 的多行注释有两种，一种使用的是三个单引号 **‘’'**，另一种是三个双引号 **“”"**。Python 的两种多行注释都不可以嵌套使用，但两种多行注释混合使用可以嵌套。

Python 的多行注释通常用来为 Python 文件、模块、类或者函数等添加版权、功能描述等信息。

在 Python 中，如果多行注释标记（三单引号或三双引号）作为语句的一部分出现，就不能再将它们视为多行注释的标记，而应看做是字符串的标志（同双引号的作用相同）。

##### 基本语法 #####

'''
    注释内容
    '''
    
    """
    这里也是多行注释内容
    """

#### 中文编码声明注释 ####

##### 使用 #####

Python 的中文编码声明注释，主要是解决 Python2 中不支持中文的问题。

中文编码问题在 Python 3.x 中已经不存在，但为了规范编码，增强代码的可执行性，方便其他程序员及时了解程序所用的编码，建议初学者在程序开头处加上中文编码声明注释。

Python 的中文编码声明注释也有两种。

##### 基本语法 #####

# -*- coding:编码 -*-
    
    # coding=编码

### 案例 ###

#### Python单行注释 ####

Python 单行注释只能用来注释单行代码。

# 这是 Python 的单行注释，这里会被编译器忽略
    # print('Hello HaiCoder')
    print('嗨客网(www.haicoder.net)')

程序运行，控制台输出，如下图：

![请添加图片描述][070c00b2340d47039977abdfe803fbad.png]

我们可以看到，程序的输出为 `嗨客网(www.haicoder.net)`，而并没有输出上面的 `Hello HaiCoder` 。

程序的第一行代码和第二行代码都被注释了，所以不会被执行。

#### Python多行注释 ####

使用三个单引号注释多行 Python 代码。

'''
        这是 Python 的多行注释，这里会被编译器忽略
        print('Hello HaiCoder')
    '''
    
    print('嗨客网(www.haicoder.net)')

程序运行，控制台输出，如下图：

![请添加图片描述][c5325b6150404aceaf8893109e3f88c6.png]

我们可以看到，程序的输出为 `嗨客网(www.haicoder.net)`，而并没有输出上面的 `Hello HaiCoder` 。

程序的第一行代码和第二行代码都被多行注释给注释了，所以不会被执行。

#### Python多行注释 ####

使用三个双引号注释多行 Python 代码。

"""
        这是 Python 的多行注释，这里会被编译器忽略
        print('Hello HaiCoder')
    """
    
    print('嗨客网(www.haicoder.net)')

程序运行，控制台输出，如下图：

![请添加图片描述][59eff816003e4ddda8af203058a419f7.png]

我们可以看到，程序的输出为 `嗨客网(www.haicoder.net)`，而并没有输出上面的 `Hello HaiCoder` 。

程序的第一行代码和第二行代码都被多行注释给注释了，所以不会被执行。

#### Python多行注释 ####

Python 多行注释不可以嵌套。

"""
        """ 1 """
        这是 Python 的多行注释，这里会被编译器忽略
        Python多行注释不能嵌套
        print('Hello HaiCoder')
    """
    
    print('嗨客网(www.haicoder.net)')

程序运行，控制台输出，如下图：

![请添加图片描述][f8c766a4cc334121bf5052756605c184.png]

我们在三个双引号多行注释里面嵌套了三个双引号的多行注释。我们可以看到，运行时直接报错，因为相同的多行注释是不支持嵌套的。

#### Python多行注释 ####

Python 不同的多行注释可以嵌套。

"""
        ''' 111 '''
        这是 Python 的多行注释，这里会被编译器忽略
        Python多行注释不能嵌套
        print('Hello HaiCoder')
    """
    
    print('嗨客网(www.haicoder.net)')

程序运行，控制台输出，如下图：

![请添加图片描述][03a679a336854f15afbac7275d70968d.png]

我们在三个双引号多行注释里面嵌套了三个单引号的多行注释。我们可以看到，运行正确，因为不同的多行注释是可以支持嵌套的。

#### Python非多行注释 ####

多行注释作为语句的一部分出现，就不能再将它们视为多行注释的标记。

print('''嗨客网(www.haicoder.net)''')

程序运行，控制台输出，如下图：

![请添加图片描述][dff6c0d45d5449d69b0d400a9be944e9.png]

我们在 print 语句中使用了三个单引号的多行注释。多行注释作为语句的一部分出现，就不能再将它们视为多行注释的标记，而是当做字符串标记，因此程序输出了 `嗨客网(www.haicoder.net)`。

#### Python中文编码声明注释 ####

Python 的中文编码声明注释，主要是解决 Python2 中不支持中文的问题。

# coding=utf-8
    print('''嗨客网(www.haicoder.net)''')

程序运行，控制台输出，如下图：

![请添加图片描述][e5926f2e12f44d468fdc5755ce230e6e.png]

我们在代码的第一句使用了 Python 中文编码声明注释。Python 中文编码声明注释也不会被执行，只是告诉编译器当前程序使用的编码，因此程序输出了 `嗨客网(www.haicoder.net)`。

### Python注释总结 ###

用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性。一旦程序中某部分内容被注释掉，则该内容将会被 Python 解释器忽略，换句话说，此部分内容将不会被执行。

Python 提供了三种注释的形式单行注释 、多行注释和中文编码声明注释。

[070c00b2340d47039977abdfe803fbad.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/7ea42af0b55540c1b7e34c1c486884f0.png
[c5325b6150404aceaf8893109e3f88c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/1baf20d48c4a4c858179e21d78e22044.png
[59eff816003e4ddda8af203058a419f7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/8f993596082743dda28f184a4bbb87ff.png
[f8c766a4cc334121bf5052756605c184.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/c3cb5bd31c9f43a78ee1a0e2d9ab11b2.png
[03a679a336854f15afbac7275d70968d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/c807b0170c3b44e1b71b6091dd7aabd3.png
[dff6c0d45d5449d69b0d400a9be944e9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/dd0c0624405944539e31380778559382.png
[e5926f2e12f44d468fdc5755ce230e6e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/ee42578eb38a4b5b97a6c2d237169c50.png