Python注释全解析：从新手到专家的注释之道

什么是Python的注释

那么什么是代码注释呢？注释很简单其实它就是用来说明解释原代码的，注释它不是代码因为它不会被Python解释器解释。python中的注释有多种，有单行注释，多行注释。注释的作用非常明显：

它可以提高代码的可读性，方便后期的维护，此外它还能方便我们调试程序。

团队合作的时候，个人编写的代码经常会被多人调用，为了让别人能更容易理解代码的用途，良好规范注释是非常有必要的。

代码注释初感受

这里有两份代码，左边一份，右边一份。如果让你选择来阅读的话，你会选择哪一个呢？

当我看到左边代码的时候，我的心情是这样的：啥啥啥 写的这啥？而右边的代码却让我有兴读下去。仔细观察发现，其实这两份代码是相同的。那么为什么给人的感觉却差这么多呢，主要是右边的代码它有一个解释说明，通过这里的解释说明文字。虽然我没有仔细阅读每一行代码，但我就能猜出个大概，知道这个代码它主要实现什么功能。这样以后在使用它或者是修改它的时候，看到注释就会知道对应代码段的功能，所以我会选择右边的代码，而右边代码中的解释说明文字也就是我们本节要介绍的内容

单行注释

用一个#号来，#号表示后面是我们注释的内容，通常#号和注释内容之间有一个空格，这就是一种编码规范而已，如果不加空格也是可以的。

print('hello daxiong')  # 这是一个注释多行注释

多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来，下面我们就在代码中演示一下

三个单引号 ''' 多行注释

'''这是多行注释，用三个单引号这是多行注释，用三个单引号 这是多行注释，用三个单引号'''print("Hello, daxiong!")

三个双引号 """多行注释

"""这是多行注释，用三个双引号这是多行注释，用三个双引号 这是多行注释，用三个双引号"""print("Hello, daxiong!")如何写好注释

有的小伙伴可能会觉得既然注释这么有用，那么我把每行代码全给它注释上岂不是更好！下面我们就来介绍一下什么是良好的注释和糟糕的注释，其实好与坏之间并没有统一的标准，它只是程序员们对于代码编写的经验的总结而已。在这里我隆重地向你推荐一本编程图书《代码整洁之道》，这是一本非常经典的编写代码指导图书，在这本书里有整整一章的内容用来写注释 足以见得注释的重要性。接下来我们就来介绍几种书中认为的优秀的注释和糟糕的注释

什么是优秀的注释？

它是能够提供信息的注释也就是说我看到代码的第一眼，通过它的注释我就知道这段代码是用于实现什么功能的

对意图的注释：就是说在你的注释中可以说明这段代码的目的

阐释：把某些晦涩难懂的参数或者返回值的意义翻译为可读的形式

to do注释：这个有点像to do list待办清单，例如你的项目1.0着急上线，有一些功能还没有完成，此时你就可以先加一个to do注释，提示自己在下一个版本中去实现这个功能

糟糕的注释

喃喃自语：你是站在自身的角度来写注释，不考虑其他人能否看懂

多余的注释：比如我们前面写的对hello world做的注释，其实它就是一条多余的注释，因为hello world是最简单的代码 任何人都看得懂，所以它就没有必要再加注释。如果加了注释，反而增加了阅读代码的负担，所以对于大家都看得懂的代码就不要再写多余的注释了

误导性的注释：当你在写注释的时候，如果你自己都表述不清，那么很容易给别人造成误导，本来能看得懂的 结果被你的注释弄糊涂了

日志性的注释：在开发需求变更的时候，我们经常会加上这样的注释：变更原因、变更时间及编写人等，这是一种挺好的方式来记录一下这个变更。但是如果这个需求经常性的变更，比如说你之前写的是1.0 现在变成1.1，你又写了一堆日志的注释 需求又再次变更变成1.2，你又写了一堆注释 1.3又是一堆注释，最后很可能这个注释比代码还要长，所以这种日志性的注释如果非常长的话，它就是一个糟糕的注释。

废话的注释。