Python零基础从入门到精通详细教程1-注释

1.简介

关于Python的介绍、安装以及开发工具的安装宏哥这里就不做赘述了，需要了解的可以自行查找资料或者看宏哥之前的文章进行了解和学习。这里宏哥就直接上干货，开门见山。今天我们首先来讲解和学习一下Python的注释，大家不要觉得简单而不重视或者忽略了它。注释在我们日常工作中还是非常重要的。否则我们就会出现以下几种窘境：

①时间久了，再次看代码的时候，不知所以然；

②后期其他维护同事的灾难，天天对着你写的代码爆粗口。

 好了，其他废话不说，回归到今天的主题-Python的注释。既然是零基础学习Python，那先跟随宏哥来看看今天的学习目标。

2.目标

1.注释是什么

2.注释的作用

3.注释的分类及语法

4.注释的特点

3.注释是什么？

用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性。一旦程序中某部分内容被注释掉，则该内容将会被 Python 解释器忽略，换句话说，此部分内容将不会被执行。注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来，再用代码去体现。

我们引入百度百科的解释：

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。注释只是为了提高可读性，不会被计算机编译。

这里解释下，注释是给人看的，电脑会自动跳过不会执行，它使得我们的代码更“人性化”，更具有可读性。

4.注释的作⽤

注释不仅可以用来解释程序某些部分的作用和功能（用自然语言描述代码的功能），在必要时，还可以将代码临时移除，是调试程序的好帮手。 通常而言，合理的代码注释应该占源代码的 1/3 左右。

1.没有注释的代码，如下图所示：

2.添加注释的代码，如下图所示：

通过⽤⾃⼰熟悉的语⾔，在程序中对某些代码进⾏标注说明，这就是注释的作⽤，能够⼤⼤增强程序的可读性。

5.注释的分类及语法

Python注释分为三类：单⾏注释 、多⾏注释中文编码声明注释。。

5.1单⾏注释

Python的单行注释可以嵌套使用。以#开头，#右边所有东西都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用。只能注释⼀⾏内容，语法如下：

# 注释内容

为了保证代码的可读性，#后面建议先添加一个空格，然后再编写相应的说明文字。

5.2多⾏注释

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

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

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

如果希望编写的注释信息很多，一行无法显示，就可以使用多行注释。

要在Python程序中使用多行注释，可以用一对连续的三个引号（单引号和双引号都可以）。

可以注释多⾏内容，⼀般⽤在注释⼀段代码的情况， 语法如下：

"""
 第⼀⾏注释
 第⼆⾏注释
 第三⾏注释
"""
'''
 注释1
 注释2
 注释3
'''

注意：

注释不是越多越好，对于一目了然的代码，不需要添加注释；对于复杂的操作，应该在操作开始前协商若干行注释；对于不是一目了然的代码，应在其行尾添加注释。‍

5.3中文编码声明注释

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

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

Python 的中文编码声明注释也有两种。基本语法如下：

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

6.快速体验

6.1单⾏注释

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

# 输出hello world
# print('hello 北京-宏哥')
print('hello world')
print('hello Python') # 输出(简单的说明可以放到⼀⾏代码的后⾯，⼀般习惯代码后⾯添加两个空格再书写注释⽂字)

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

我们可以看到，程序的输出为 hello world 和 hello Python，而并没有输出上面的 Hello 北京-宏哥 。

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

6.2多⾏注释

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

'''
    这是 Python 的多行注释，这里会被编译器忽略
    print('Hello 北京-宏哥')
'''

print('北京-宏哥')

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

我们可以看到，程序的输出为 北京-宏哥，而并没有输出上面的 Hello 北京-宏哥 。 程序的第一行代码和第二行代码都被多行注释给注释了，所以不会被执行。

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

"""
    这是 Python 的多行注释，这里会被编译器忽略
    print('Hello 北京-宏哥')
"""

print('北京-宏哥')

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

我们可以看到，程序的输出为 北京-宏哥，而并没有输出上面的 Hello 北京-宏哥 。 程序的第一行代码和第二行代码都被多行注释给注释了，所以不会被执行。

3.Python 多行注释不可以嵌套。

"""
    """ 1 """
    这是 Python 的多行注释，这里会被编译器忽略
    Python多行注释不能嵌套
    print('Hello 北京-宏哥')
"""

print('北京-宏哥')

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

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

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

"""
   ''' 111 '''
    这是 Python 的多行注释，这里会被编译器忽略
    Python不同多行注释能嵌套
    print('Hello 北京-宏哥')
"""

print('北京-宏哥')

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

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

6.3Python非多行注释

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

print('''北京-宏哥''')

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

我们在 print 语句中使用了三个单引号的多行注释。多行注释作为语句的一部分出现，就不能再将它们视为多行注释的标记，而是当做字符串标记，因此程序输出了 北京-宏哥。

6.4Python中文编码声明注释

Python 的中文编码声明注释，主要是解决 Python2 中不支持中文的问题。因为之前Python刚出来，可能不完善吧，后期升级优化的Python3就没有这个问题了。

# coding=utf-8
print('''北京-宏哥''')

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

我们在代码的第一句使用了 Python 中文编码声明注释。Python 中文编码声明注释也不会被执行，只是告诉编译器当前程序使用的编码，因此程序输出了  北京-宏哥 。如果是python2没有声明就会出现中文乱码。

注意：解释器不执⾏任何的注释内容。

7.总结

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

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

7.1注释是什么

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。注释只是为了提高可读性，不会被计算机编译。

7.2注释的作⽤

⽤⼈类熟悉的语⾔对代码进⾏解释说明，⽅便后期维护。

7.3注释的分类

单⾏： # 注释内容 ，快捷键ctrl+/

多⾏： """ 注释内容 """ 或 ''' 注释内容 '''

声明注释：# coding=utf-8 或者 # -*- coding:编码 -*-

解释器不执⾏注释内容

8.拓展

8.1代码注释的重要性

代码注释是指在程序代码中添加的解释性说明，用于描述代码的功能、目的、使用方法等。代码注释对于程序的重要性主要体现在以下几个方面：

提高代码的可读性:代码注释可以帮助开发人员和其他人员快速理解代码的功能和目的，避免阅读代码时产生歧义。

降低代码维护成本:随着程序的不断更新和扩展，代码可能会变得越来越复杂，这将给维护人员带来很大的困难。代码注释可以帮助维护人员快速理解代码的逻辑，并根据需要进行修改或扩展。

提高代码的质量:代码注释可以帮助开发人员发现代码中的错误和缺陷，并及时进行改进。前言 – 人工智能教程.

具体来说，代码注释可以用于以下场景：

描述代码的功能和目的：例如，一个函数的注释可以描述该函数的功能、参数和返回值。

解释代码的逻辑：例如，一个复杂的代码逻辑可以使用注释进行解释，以便开发人员和其他人员能够更好地理解。

说明代码的使用方法：例如，一个 API 函数的注释可以说明该函数的使用方法和参数。

记录代码的修改历史：例如，一个注释可以记录代码的修改日期、修改者和修改内容。

在实际开发中，代码注释应该做到以下几点：

注释应与代码保持一致：注释应该与代码保持一致，不要出现前后矛盾的情况。

注释应简明扼要：注释应该简明扼要，避免使用过多的专业术语。

注释应及时更新：代码发生修改后，相应的注释也应该及时更新。

总之，代码注释是程序开发中必不可少的一部分，它可以帮助提高代码的可读性、可维护性和质量。开发人员应该养成写代码注释的习惯，以提高程序的开发效率和质量。

8.2你认为程序员不写注释的原因是什么

程序员不写注释的原因有很多，主要有以下几点：

时间压力：在项目有紧迫截止日期的情况下，程序员可能会觉得写注释是一个额外的任务，会增加开发时间。这种压力可能导致他们选择不写注释，以尽快完成任务。然而，长期来看，缺乏注释可能会导致维护成本上升，最终耗费更多时间。

缺乏团队协作意识：在团队中工作时，缺乏团队协作意识可能导致程序员不愿意编写注释。他们可能觉得只有自己能够理解自己的代码，而忽视了其他团队成员的需求。然而，好的注释是协作的关键，它们有助于团队成员之间的沟通和合作。

对注释的误解：一些程序员认为，代码应该是自解释的，不需要注释。他们认为注释会使代码变得冗余，影响代码的可读性。然而，实际情况是，即使是最优秀的代码也需要注释来提高可读性和可维护性。

缺乏注释规范：在很多公司中，没有明确的注释规范。这导致注释的质量参差不齐，给阅读代码的人带来困难。前言 – 人工智能教程

为了鼓励程序员写注释，可以从以下几方面入手：

提高开发人员的意识：让开发人员了解注释的重要性，并培养他们写注释的习惯。

制定统一的注释规范：制定统一的注释规范，规范注释的格式、内容和语法。

建立注释评审机制：在代码审查过程中，对注释进行评审，帮助开发人员改进注释。

8.3如何才能写出漂亮的注释

提示漂亮的代码注释应该具备以下几个特点：

准确性：注释应该准确地描述代码的功能、目的、使用方法等。

简洁性：注释应该简洁明了，避免使用过多的专业术语。

一致性：注释应该与代码保持一致，不要出现前后矛盾的情况。

及时性：代码发生修改后，相应的注释也应该及时更新。

以下是一些写出漂亮代码注释的建议：

明确注释的目的：在写注释之前，先要明确注释的目的是什么。是描述代码的功能，还是解释代码的逻辑，还是说明代码的使用方法？明确了注释的目的，才能写出更有针对性的注释。

使用标准的注释格式：不同的编程语言有不同的注释格式，在写注释时要使用标准的注释格式，以便其他开发人员能够轻松阅读和理解。

使用简洁的语言：注释应该使用简洁的语言，避免使用过多的专业术语，以便其他开发人员能够快速理解.

及时更新注释：代码发生修改后，相应的注释也应该及时更新，以确保注释与代码保持一致。

以下是一些常见的代码注释错误：

注释不准确：注释不准确会导致其他开发人员误解代码的功能和目的。

注释过于冗长：注释过于冗长会使代码变得臃肿，影响代码的可读性。

注释与代码不一致：注释与代码不一致会导致其他开发人员感到困惑。

注释没有及时更新：注释没有及时更新会导致注释与代码不一致。

总之，漂亮的代码注释是程序开发中必不可少的一部分，它可以帮助提高代码的可读性、可维护性和质量。程序员应该养成写代码注释的习惯，并注意避免常见的代码注释错误，以提高注释的质量。